FolderReader.GetChildContainers Method (ConnectionId, SessionId, String, Int32, Int32, String)

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)

Syntax

public string GetChildContainers(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int recordCount,
	out int status,
	out string statusText
)

Public Function GetChildContainers ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	<OutAttribute> ByRef recordCount As Integer,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As String

Parameters

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
xmlParameterData: Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
recordCount: Type: SystemInt32
Returns the total entries found
status: Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText: Type: SystemString
The textual representation of the call result.

Return Value

Type: String
Xml

Examples

Copy

<root>
 <status>integer value</status>
 <statustext>string value</statustext>
 <containers>
    <status>integer value</status>
    <statustext>string value</statustext>
    <container id="integer value" 
               name="string value" 
               type="string value" 
               module="Dokument" 
               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 -->
 </containers>
</root>

Element/attribute	Type	Description
/root/status	integer	Indicates the outcome of the call; always 0 (success)
/root/statustext	string	The textual outcome of the call; always Success
/root/containers/container		An element representing one single child container
/root/containers/container@id	integer	The container's identifier
/root/containers/container@name	string	The name of the container
/root/containers/container@type	string	The type of container ('U' or 'C') - (Unit \| Category)
/root/containers/container@module	string	The name of the module in use. See ModuleName for more information about this value.
/root/containers/container@child	bit (0 / 1)	1 if the document has child documents; otherwise, 0
/root/containers/container@parentid	integer	The identifier of the parent container. When this value is equal to the id, the container has no parent.
/root/containers/container@unitid	integer	The identifier of the container's unit. Every category is connected to a unit whether or not they have a parent category.
/root/containers/container@categoryid	integer	the id of the category
/root/containers/container@description	string	The container description, if any
/root/containers/container@hasdirectace	bit (0 / 1)	1 when the container has direct security entries set (ACE); otherwise, 0
/root/containers/container@customviewurl	string	An 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.

Remarks

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.

Reference

FolderReader Class

GetChildContainers Overload

ContentStudio.Document Namespace