Procedure CaseLoadCurrent(case[, dialog][, keepUnreferencedRuntimeLibs])

CaseLoadCurrent

The procedure CaseLoadCurrent loads an existing case as the new current case. You can use it to load either a case that is passed as argument to the procedure, or a case that the user can select via a dialog box. If the data of the currently loaded case has changed, then the user is asked to save this data first.

CaseLoadCurrent(
    case,    ! (input/output) An element parameter into AllCases
    [dialog],                     ! (optional) 0 or 1
    [keepUnreferencedRuntimeLibs  ! (optional) 0 or 1
)

Arguments

case

An element parameter into the pre-defined set AllCases. If the argument dialog is set to 0, then no dialog box is shown and the case to which the element parameter currently refers is loaded. If the argument dialog is set to 1, then the value of the element parameter is used to initialize the dialog box. The case that the user has selected and is loaded successfully is returned through this argument.

dialog (optional)

An integer value indicating whether or not the user gets a dialog box in which he can select the case to load. The default value is 1, thus if this argument is omitted the dialog box will be shown.

keepUnreferencedRuntimeLibs (optional)

An integer value indicating whether or not any runtime libraries in existence before the case is loaded, but not referenced in the case, should be kept in memory or destroyed during the case load. The default is 0 indicating that the runtime libraries not referenced in the case should be destroyed during the case load.

Return Value

The procedure returns \(1\) on success. If the user cancelled the operation, then the procedure returns \(0\). If any other error occurs then the procedure returns \(-1\) and CurrentErrorMessage will contain a proper error message.

Note

  • This function is only applicable if the project option Data_Management_style is set to Single_Data_Manager_file.

  • If you want to suppress the dialog box for the unsaved data, then you may call CaseSetChangedStatus(0) prior to CaseLoadCurrent.

  • If the option Data_Management_style is set to disk_files_and_folders, please use the function CaseCommandLoadAsActive instead.

See also

The procedures CaseLoadIntoCurrent, CaseMerge, CaseSave, CaseSetChangedStatus.