insightlistscenattach
insightlistscenattach |
Purpose
Synopsis
function insightlistscenattach:list of insightattachment
function insightlistscenattach(scenariopath:text):list of insightattachment
Argument
|
scenariopath
|
The path of a scenario. A scenario path is the full path to a scenario name starting from the repository root and including the app name. E.g. /myapp/FolderA/FolderB/myscenario If the scenario path is not specified, the attachment is retrieved for the current scenario
|
Return value
A list of the scenario attachments
Example
Example of fetching information about all attachments of a scenario into a list called
myattachments
declarations
myattachments: list of insightattachment
end-declarations
myattachments := insightlistscenattach
if insightattachstatus=INSIGHT_ATTACH_OK then
writeln("Attachments: ", myattachments)
else
writeln("Error listing attachments")
end-if
Getting the list of attachments for the current scenario
declarations
myattachments: list of insightattachment
end-declarations
myattachments := insightlistscenattach('/myapp/FolderA/FolderB/myscenario')
if insightattachstatus=INSIGHT_ATTACH_OK then
writeln("Attachments: ", myattachments)
else
writeln("Error listing attachments")
end-if
Getting the list of attachments for a scenario with path /myapp/FolderA/FolderB/myscenario
Further information
1. Check the attachment status code using
insightattachstatus to determine whether the attachments list was successfully retrieved.
2. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error.
Related topics