Selecting properties of a file or folder in an Encyclopedia volume
Use SelectFiles to retrieve the name or ID of a single file or folder or a list of files or folders in an Encyclopedia volume. Using ResultDef, you can also retrieve specific properties of each file or folder or list. SelectFiles does not retrieve file or folder content.
To select a file or folder and view its properties, use TargetVolume in the SOAP header to indicate which Encyclopedia volume contains the item. SelectFiles can search all subfolders in a directory. To restrict a search to the items in a single directory, not including subfolders, use GetFolderItems.
SelectFiles supports searches that use the following criteria:
Use NameList or IdList to retrieve a list of files or folders in a directory.
Use Name or Id to retrieve a single file or folder.
Use Search to retrieve all files or folders that match a given condition.
In a SelectFiles request, you can identify by name or ID the working folder from which to select files. You can indicate whether the search is recursive, meaning that it includes subdirectories of the working folder. You can also specify whether to retrieve only the latest version of the file.
Use ResultDef to specify the file or folder properties to retrieve. The properties you set in ResultDef depend on the type of item. For example, if the item is a file, you can retrieve the file name, ID, description, file type, page count, date of creation or last update, owner, and version name and number. If the item is a folder, you cannot retrieve a file type, version name and number, file size, or page count.
Using SelectFiles, you can set a privilege filter that restricts the result to users in a given security role. When the results of a SelectFiles request exceed the FetchSize, the response returns a FetchHandle to support retrieving the total result.