Online documentation - WebsydianExpress v3.5 |
APIServer.Folderlist.GetFolderListsForSite
Field | Variable | ...as | Description |
---|---|---|---|
FolderListName | Position | Input | The name of the folder list. |
FolderListSiteKey | Position | Input | The site the folder list is defined in. |
Position | Control | Input | Specifies whether the data in the Position variable is used for positioning when fetching the data. |
RowsFetched | Control | Dual | The number of fetched records in the output variable FetchedData. |
FolderListID | FetchedData(64) | Output | The unique identification of the folder list. |
FolderListText | FetchedData(64) | Output | A description of the folder list. |
FolderListAuthLevel | FetchedData(64) | Output | Not used. |
FolderListName | FetchedData(64) | Output | The name of the folder list - it is this field, which is shown for the identification of the folder list in the administration interface. The combination of FolderListName and FolderListSiteKey is unique. |
FolderListSiteKey | FetchedData(64) | Output | Identifies the site, which the folder list is defined for . |
This API behaves like a standard BlockFetch function. The data is restricted to the site specified by the input field FolderListSiteKey in the Position variable. The data will be shown in FolderListName order.
To make it easier to use this API function, a dummy view (WSYAPI/DataStructures.FolderLists.BySiteName) is provided. Use this view to replace in e.g. grid page functions.