ErrorManagerGetListPageable Method (ConnectionId, SessionId, 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 entries in the Content Studio event log.

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

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

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).
pageNumber
Type: SystemInt32
The page number to read. If this value is less than 1 pageNumber will be 1.
pageSize
Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pagesize will be 10.
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
Examples

<root>
  <status>integer value</status>
  <statustext>string value</statustext>
  <entries>
    <entry index="integer"
           level="integer"
           eventid="integer"
           connectionid="short"
           source="string"
           machinename="string"
           message="string"
           written="sortable datetime value"
      />
     <!-- more entries can follow -->
  </entries>
  <pageno>integer value</pageno>
  <pagesize>integer value</pagesize>
  <pagecount>integer value</pagecount>
  <recordcount>integer value</recordcount>
</root>
Element/attributeTypeDescription
/root/statusintegerIndicates the outcome of the call; always 0 (success)
/root/statustextstringThe textual outcome of the call; always Success
/root/entries/entryAn element representing one single log entry
/root/entries/entry@indexintegerThe entry index
/root/entries/entry@levelintegerThe level (severity) of the entry. See list below for the meaning of this value.
/root/entries/entry@eventidintegerGets the resource identifier that designates the message text of the event entry.
/root/entries/entry@connectionidshortA value that identifies the web site
/root/entries/entry@sourcestringGets the name of the application that generated this event.
/root/entries/entry@machinenamestringGets the name of the computer on which this entry was generated.
/root/entries/entry@messagestringGets the localized message associated with this event entry.
/root/entries/entry@writtenintegerGets the local time at which this event was written to the log.
/root/pagenointegerThe ordinal number of the data pages returned. First page is 1.
/root/pagesizeintegerThe size of each data page
/root/pagecountintegerThe total number of data pages found.
/root/recordcountintegerThe total number of records found.

The level attribute can be one of the following numeric values

  • 1 - Error
  • 2 - Warning
  • 3 - Information
  • 4 - Success audit
  • 5 - Failed audit
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.
See Also

Reference