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

public string List(
	ConnectionId connectionId,
	SessionId sessionId,
	int objectId,
	int currentId,
	WFLogManagerLogScope scope,
	WFLogManagerLoglistFilter filter,
	WFLogManagerLoglistSortOrder sortOrder,
	int pageSize,
	ref int pageNumber,
	out int pageCount,
	out int recordCount
)

Public Function List ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	objectId As Integer,
	currentId As Integer,
	scope As WFLogManagerLogScope,
	filter As WFLogManagerLoglistFilter,
	sortOrder As WFLogManagerLoglistSortOrder,
	pageSize As Integer,
	ByRef pageNumber As Integer,
	<OutAttribute> ByRef pageCount As Integer,
	<OutAttribute> ByRef recordCount As Integer
) 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 typically is retrieved from a call to the OpenSession method

objectId

Type: SystemInt32
An identifier to an object to list log items for. What type of object this identifier represents is dependent of the value of the scope parameter. For Site use the value 1

currentId

Type: SystemInt32
Represents an existing object id. This parameter is used to ensure that the data page of a specific item is returned regardless of the pageNumber specified. This ensures that you will not lose track of a selected log item when the list is re-sorted and the item is placed on a different data page. If this parameter is zero the pageNumber parameter will be used to specify the data page to return rather than currentId.

scope

Type: ContentStudio.Document.Workflow.ManagementWFLogManagerLogScope
A value that specifies for what type of object to list workflow log items from.

filter

Type: ContentStudio.Document.Workflow.ManagementWFLogManagerLoglistFilter
Indicates what type of log items to return in the list.

sortOrder

Type: ContentStudio.Document.Workflow.ManagementWFLogManagerLoglistSortOrder
Specifies how the returned list of log items should be sorted.

pageSize

Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 PageSize will be 1.

pageNumber

Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1.
If currentId is specified the input value of this parameter will be ignored. After the call this parameter contains the number of the data page returned. This value can be used by code that specifies the currentId parameter and needs to know the page number of that item.

pageCount

Type: SystemInt32
After the call this parameter contains the total number of data pages found. This parameter is passed uninitialized.

recordCount

Type: SystemInt32
After the call this parameter contains the total number of log items found. This parameter is passed uninitialized.

Return Value

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <pageno>Integer value</pageno>
  <pagecount>Integer value</pagecount>
  <recordcount>Integer value</recordcount>
  <filtercriteria>Integer value</filtercriteria>
  <logs>
    <log id="Integer value"
         level="Integer value"
         logdate="Date/time value"
         summary="String value"
         details="String value"
         title="String value"
         username="String value"
         documentid="Integer value"
         categoryid="Integer value"
         categoryname="String value" />
    <!-- more log elements follow -->
  </logs>
</root>

Reference