User.GetList Method (ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String)

UserGetList Method (ConnectionId, SessionId, String, Int32, Int32, Int32, 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 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

Copy

public string GetList(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	int pageSize,
	int pageNumber,
	out int pageCount,
	out int recordCount,
	out int status,
	out string statusText
)

Public Function GetList ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	pageSize As Integer,
	pageNumber As Integer,
	<OutAttribute> ByRef pageCount As Integer,
	<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
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
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 containing the pageable list of users

Remarks

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

User Class

GetList Overload

ContentStudio.Security Namespace