AppDB ReadFolderItems() Method

(SBM On-Premise/PaaS only) Provides a list of items in a folder.

Function Signature

 bool ReadFolderItems( FolderItemList& list, int folderId )

Parameters

Parameter	Type	Description
list	FolderItemList&	(Output) The list of items in the folder.
folderId	int	The parent folder of the items you wish to access.

Return

Type	Description
bool	Returns true if the method was successful; false if not. A successful read may return zero results if no items match the query. Check for results by calling the AppRecordList.empty() method.

Technical Details

SBM ModScript version: 11.3.

Notes

Create a FolderItemList and pass in the TS_ID from the TS_Folders table of the folder you would like. Keep in mind that a folder ID is needed to retrieve this list and the folder table contains an inbox for every user so it may be a bit of processing to find the correct TS_ID from the TS_Folders table before this method can be used effectively.