FolderReaderGetChildContainers Method (ConnectionId, SessionId, Int32, FolderBaseCSFileFolderTypes, FolderReaderFolderSortOrder, Int32) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns a list of containers that exist within another container

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string GetChildContainers(
	ConnectionId connectionId,
	SessionId sessionId,
	int containerId,
	FolderBaseCSFileFolderTypes containerType,
	FolderReaderFolderSortOrder sortOrder,
	out int recordCount


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemInt32
The id of the container that should act as a starting point for the list.
Type: ContentStudio.DocumentFolderBaseCSFileFolderTypes
A member of the FolderBaseCSFileFolderTypes enumeration that indicates the type of container indicated in the ContainerID parameter. If the type Root is supplied the ContainerID parameter is ignored.
Type: ContentStudio.DocumentFolderReaderFolderSortOrder
A member of the FolderReaderFolderSortOrder enumeration that specifies how the list should be sorted
Type: SystemInt32
Returns the total entries found

Return Value

Type: String

 <status>integer value</status>
 <statustext>string value</statustext>
    <status>integer value</status>
    <statustext>string value</statustext>
    <container id="integer value" 
               name="string value" 
               type="string value" 
               child="bit value (0 / 1)" 
               parentid="integer value" 
               unitid="integer value" 
               categoryid="integer value" 
               description="string value" 
               hasdirectace="bit value (0 / 1)" 
               customviewurl="string value" />
    <!--more child containers can follow -->
/root/statusintegerIndicates the outcome of the call; always 0 (success)
/root/statustextstringThe textual outcome of the call; always Success
/root/containers/containerAn element representing one single child container
/root/containers/container@idintegerThe container's identifier
/root/containers/container@namestringThe name of the container
/root/containers/container@typestringThe type of container ('U' or 'C') - (Unit | Category)
/root/containers/container@modulestringThe name of the module in use. See ModuleName for more information about this value.
/root/containers/container@childbit (0 / 1)1 if the document has child documents; otherwise, 0
/root/containers/container@parentidintegerThe identifier of the parent container. When this value is equal to the id, the container has no parent.
/root/containers/container@unitidintegerThe identifier of the container's unit. Every category is connected to a unit whether or not they have a parent category.
/root/containers/container@categoryidintegerthe id of the category
/root/containers/container@descriptionstringThe container description, if any
/root/containers/container@hasdirectacebit (0 / 1)1 when the container has direct security entries set (ACE); otherwise, 0
/root/containers/container@customviewurlstringAn alternate url to a document that will be displayed in the administrative interface when the container is clicked - Custom view. Empty if the category has no custom view. Empty if the container is a unit.

CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
See Also