FolderReader.GetChildContainers Method (ConnectionId, SessionId, Int32, FolderBase.CSFileFolderTypes, FolderReader.FolderSortOrder, Int32)

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)

Syntax

Copy

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

Public Function GetChildContainers ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	containerId As Integer,
	containerType As FolderBaseCSFileFolderTypes,
	sortOrder As FolderReaderFolderSortOrder,
	<OutAttribute> ByRef recordCount As Integer
) 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).
containerId: Type: SystemInt32
The id of the container that should act as a starting point for the list.
containerType: 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.
sortOrder: Type: ContentStudio.DocumentFolderReaderFolderSortOrder
A member of the FolderReaderFolderSortOrder enumeration that specifies how the list should be sorted
recordCount: Type: SystemInt32
Returns the total entries found

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.

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Reference

FolderReader Class

GetChildContainers Overload

ContentStudio.Document Namespace