GetWorkspaceItemDbIdList
Description
Returns a list of DBIDs of workspace items based on the input criteria.
Note: For more information on DBIDs, see Working with records
Syntax
VBScript
workspace.GetWorkspaceItemDbIdList folder_type, item_type,
parent_dbid, entdef_name
Perl
$workspace->GetWorkspaceItemDbIdList
(folder_type, item_type,
parent_dbid, entdef_name);
- Identifier
- Description
- workspace
- The Workspace object obtained from the current session.
- folder_type
- A Long containing the folder type as enumerated
by WorkspaceFolderType. The workspace folder types are:
Public folder items (_WORKSPACE_PUBLIC_FOLDER = 1)
Personal folder items (_WORKSPACE_USER_FOLDER = 2)
- item_type
- A Long containing a WorkspaceItemType enumerated constant.
- parent_dbid
- A Long corresponding to the DBID of the parent folder. Set this to 0 for retrieving top folders.
- entdef_name
- A String containing the EntityDef name associated with the workspace item. This argument can be empty.
- Return value
- For Visual Basic, returns an array of Variants
(each containing a String) that make up the list of DBIDs of workspace
items. Each String names one DBID.
For Perl, returns a reference to an array of strings containing the DBID list.
Examples
VBScript
// Retrieves dbid for top public folder (returns a list of 1 item)
GetWorkspaceItemDbIdList(AD_WORKSPACE_PUBLIC_FOLDER, AD_WORKSPACE_FOLDER, 0,
"")
// Retrieves dbid for children folders of public query folder
GetWorkspaceItemDbIdList(AD_WORKSPACE_PUBLIC_FOLDER, AD_WORKSPACE_FOLDER,
33554440, "")