Procedure CaseFileSectionGetContentType(url, sectionName, contents)

CaseFileSectionGetContentType

The procedure CaseFileSectionGetContentType retrieves the subset reference that was used when saving a user section in a case file.

CaseFileSectionGetContentType(
        url,                ! (input) a scalar string expression
        sectionName,        ! (input) a scalar string expression
        contents            ! (output) a scalar element parameter in 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.

sectionName

The name of the user section. Any leading or trailing spaces in the name are ignored, and an empty string is not allowed.

contents

An element parameter in AllSubsetsOfAllIdentifiers. Upon return, it holds the reference to the subset that was used when saving the user section in 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.

See also