Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml description
READ permission on the site root is required in order to list units
[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)
Syntax
public string GetUnitList( ConnectionId connectionId, SessionId sessionId, FolderReaderFolderSortOrder sortOrder, out int recordCount )
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). - sortOrder
- Type: ContentStudio.DocumentFolderReaderFolderSortOrder
On of the FolderReader.FolderSortOrder enumeration values that specifies how the list is sorted. - recordCount
- Type: SystemInt32
Returns the number of items found.
Return Value
Type: StringXML containing a list of units.
<root> <status>Integer value</status> <statustext>String value</statustext> <recordcount>Integer value</recordcount> <units> <unit id="Integer value" name="String value" type="U" description="String value" hasdirectace="Bit value" /> <!-- more unit element can follow --> </units> </root>
The elements have the following meaning
Element | Attribute | Description |
---|---|---|
root/status | Integer: Indicates the outcome of the call, always 0 which indicates success | |
root/statustext | String: The textual representation of the status, always OK | |
root/recordcount | Integer: The number of records returned. | |
root/units | The root element of the returned list | |
root/units/unit | The element that contains returned unit. | |
root/units/unit | id | Integer: the unit identifier |
root/units/unit | name | String: the name of the unit |
root/units/unit | type | String: indicates the type of container, always 'U' |
root/units/unit | description | String: a brief description of the unit. |
root/units/unit | hasdirectace | Bit: Bit: a value that indicates whether the category has any direct ACE (Access control entry) |
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 |
Content Studio permissions
See Also