FolderReaderGetChildContainers Method (ConnectionId, SessionId, String, Int32, Int32, String) 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,
	string xmlParameterData,
	out int recordCount,
	out int status,
	out string statusText


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: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
Type: SystemInt32
Returns the total entries found
Type: SystemInt32
An integer indicating result of the call. Zero is success.
Type: SystemString
The textual representation of the call result.

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.

Note: The ContainerType XML parameter can be either a short string("R", "U", "C") or an integer representation of the CSFileFolderTypes enumeration.

This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.

See Also