UserGetList Method (ConnectionId, SessionId, Int32, Int32, Int32, Int32, Int32) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns a pageable list of registered user accounts. This list can contain all registered users or users filtered by domain and/or full name pattern.

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

public string GetList(
	ConnectionId connectionId,
	SessionId sessionId,
	int currentId,
	int pageSize,
	int pageNumber,
	out int pageCount,
	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).
currentId
Type: SystemInt32
This value can be zero or the id of a user that you would like to display. This will cause the page where that user exists to be returned regardless of the PageNumber parameter.
pageSize
Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10.
pageNumber
Type: SystemInt32
The page number to read.
pageCount
Type: SystemInt32
The total pages of data found
recordCount
Type: SystemInt32
The total entries found

Return Value

Type: String
XML containing the pageable list of users
Examples

<root>
  <users>
    <user>
     <SID>S-1-5-21-30605680078-3451939488-620655406-500</SID>
     <userid>3</userid>
     <domain>THEDOMAIN</domain>
     <username>Administrator</username>
     <fullname>Administrator</fullname>
     <description>Built-in account for administering the computer/domain</description>
     <disabled>0</disabled>
     <insession>0</insession>
     <isunknown>0</isunknown>
     <email>Administrator@thedomain.se</email>
    </user>
    <!-- more user nodes can follow -->
  </users>
  <pagecount>13</pagecount>
  <recordcount>26</recordcount>
  <pagesize>2</pagesize>
  <pageno>1</pageno>
  <status>0</status>
  <statustext>OK</statustext>
</root>
Exceptions

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

Reference