DocumentObj 2.5 FolderLocation

This method returns the BaseFolder and the FolderPath for the specified logical object.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated 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.
psLogicalIdStringInThe logical identifier of the object
peOutBaseFoldereBaseFolderOutIndicates the root folder to use as starting point for folder actions
pasOutFolderPathStringArrayOutString array with the label of the parent folders (except the base folder) and the requested folder (e.g. "MobilePhones","330","Modules").
palOutFolderRefsLongArrayOutLong 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 pasOutFolderPath and palOutFolderRefs include the given folder
  • Only content folders are returned. Shortcut or Query Folders that contain the object are never returned.
  • The basefolder returned in peOutBaseFolder is always one of the root folders. So for an editor template, the peBaseFolder will contain the value System and pasOutFolderPath will contain an entry for Editor template, if located within System.
  • For publications use the dedicated API function PublicationOutput25.FolderLocation.