Procedure CaseFileGetContentType(url, contents)

CaseFileGetContentType

The procedure CaseFileGetContentType retrieves the subset reference that was used when saving the case file.

CaseFileGetContentType(
         url,             ! (input) a scalar string expression
         contents         ! (output) a scalar element parameter into the
                          !          set AllSubsetsOfAllIdentifiers
    )

Arguments

url

A string referencing the url of an existing case file from which you want to retrieve the contents information. This url can point to a file on your local file system, or to a network location.

contents

An element parameter in AllSubsetsOfAllIdentifiers. On return it holds the reference to the subset that was used when saving the case file.

Return Value

The procedure returns 1 on success. If any other error occurs, the procedure returns 0 and CurrentErrorMessage will contain a proper error message.

Note

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

  • If your application is linked to the AIMMS PRO server, the url can also point to a case file stored at the server.

Example

The code:

CaseFileGetContentType(
        url         :  "data/caseA.data",
        contentType :  _ep_contentType);
display _ep_contentType ;

produces in the listing file:

_ep_contentType := 'chapterData::sectionCaseManagement::s_CaseManagementData' ;

See also

The function CaseFileSave.