DocumentObj 2.5 FolderLocation
This method returns the BaseFolder and the FolderPath for the specified logical object.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| psAuthContext | String | InOut | Deprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant. |
| psLogicalId | String | In | The logical identifier of the object |
| peOutBaseFolder | eBaseFolder | Out | Indicates the root folder to use as starting point for folder actions |
| pasOutFolderPath | StringArray | Out | String array with the label of the parent folders (except the base folder) and the requested folder (e.g. "MobilePhones","330","Modules"). |
| palOutFolderRefs | LongArray | Out | Long array with the unique identifiers of the parent folders (except the base folder) and the requested folder identifier |
Requirements are:
- The user must have read access for the folder holding the object.
Note that:
- The returned
pasOutFolderPathandpalOutFolderRefsinclude the given folder - Only content folders are returned. Shortcut or Query Folders that contain the object are never returned.
- The basefolder returned in
peOutBaseFolderis always one of the root folders. So for an editor template, thepeBaseFolderwill contain the valueSystemandpasOutFolderPathwill contain an entry forEditor template, if located withinSystem. - For publications use the dedicated API function PublicationOutput25.FolderLocation.