UnitReaderGetUnitList Method (ConnectionId, SessionId, 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 units.

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

public string GetUnitList(
	ConnectionId connectionId,
	SessionId sessionId,
	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: ContentStudio.DocumentFolderReaderFolderSortOrder
On of the FolderReader.FolderSortOrder enumeration values that specifies how the list is sorted.
Type: SystemInt32
Returns the number of items found.

Return Value

Type: String

XML containing a list of units.

    <status>Integer value</status>
    <statustext>String value</statustext>
    <recordcount>Integer value</recordcount>
       <unit id="Integer value"
             name="String value"
             description="String value"
             hasdirectace="Bit value"
       <!-- more unit element can follow --> 

The elements have the following meaning

Xml description
root/statusInteger: Indicates the outcome of the call, always 0 which indicates success
root/statustextString: The textual representation of the status, always OK
root/recordcountInteger: The number of records returned.
root/unitsThe root element of the returned list
root/units/unitThe element that contains returned unit.
root/units/unitidInteger: the unit identifier
root/units/unitnameString: the name of the unit
root/units/unittypeString: indicates the type of container, always 'U'
root/units/unitdescriptionString: a brief description of the unit.
root/units/unithasdirectaceBit: Bit: a value that indicates whether the category has any direct ACE (Access control entry)

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

READ permission on the site root is required in order to list units
See Also