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

public string GetDocumentsInCategory(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentReaderDocumentsInCategoryReturnLevel returnLevel,
	CategoryId categoryId,
	DocumentId currentId,
	DocumentReaderDocumentListFilters filterCriteria,
	DocumentReaderDocumentListSortOrder sortOrder,
	int pageSize,
	string[] fileTypes,
	ref int pageNumber,
	out int pageCount,
	out int recordCount
)

Public Function GetDocumentsInCategory ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	returnLevel As DocumentReaderDocumentsInCategoryReturnLevel,
	categoryId As CategoryId,
	currentId As DocumentId,
	filterCriteria As DocumentReaderDocumentListFilters,
	sortOrder As DocumentReaderDocumentListSortOrder,
	pageSize As Integer,
	fileTypes As String(),
	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 usually originates from a call to OpenSession(ConnectionId).

returnLevel

Type: ContentStudio.DocumentDocumentReaderDocumentsInCategoryReturnLevel
Determines how detailed return data to return.

categoryId

Type: ContentStudio.DocumentCategoryId
An identifier to the category to list from. When currentId is specified and the document exists and for documents in the recycling bin, this parameter is ignored.

currentId

Type: ContentStudio.DocumentDocumentId
An identifier to a document that should be included in the returned page. This parameter can be zero to ignore this functionality. Specifying this value to an existing document, will cause the pageNumber and categoryId parameters to be ignored on input. Instead the call searches the category where currentId belongs, applies the filter on that category and returns the data page where currentId fits in.

filterCriteria

Type: ContentStudio.DocumentDocumentReaderDocumentListFilters
A member of the DocumentReaderDocumentListFilters enumeration that specifies which documents to return.

sortOrder

Type: ContentStudio.DocumentDocumentReaderDocumentListSortOrder
A member in the DocumentListSortOrder enumeration that specifies the sort order of the list.

pageSize

Type: SystemInt32
The size of the pageing to use. If this value is zero or negative 1 is used.

fileTypes

Type: SystemString
Defines an array of file extensions that can be used for filter documents in this category. The file extension must start with a period (.). Use the value *. to allow any file extension. If any of the entries contains .* all other items will be discarded. This parameter can be an empty array. This parameter can be null (Nothing in Visual Basic) to use the default value (.*). Internally this array is joined to a comma delimited string of file extensions and the size of this inter value cannot exceed MAX_ALLOWED_FILETYPES_SIZE number of characters, thus always keep in mind the extra comma added to each file extension when checking the text length of all elements in the array.

pageNumber

Type: SystemInt32
The page to return. If currentId is specified the input of this value is ignored but after the call the parameter is filled with the number of the page actually returned.

pageCount

Type: SystemInt32
Returns the number of pages found

recordCount

Type: SystemInt32
Returns the number of records found.

Return Value

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <pageno>1</pageno>
  <pagecount>1</pagecount>
  <recordcount>1</recordcount>
  <unitid>40</unitid>
  <parentid>561</parentid>
  <module>Dokument</module>
  <location>MyUnit/HTML/</location>
  <categoryid>561</categoryid>
  <isenabledforpdf>0</isenabledforpdf>
  <documents>
    <document publishstatus="2" 
                 id="4420" 
                 name="HelloCS5" 
                 type="text/html" 
                 modified="2007-02-28T15:27:57.323" 
                 filename="MyUnit/HTML/BCC7232E-BD9F-4112-9929-275EE7121204.aspx" 
                 checkoutstatus="1" 
                 publishdate="2007-02-28T15:25:00" 
                 filesize="996" 
                 revisionstatus="0" 
                 deleteddate="1900-01-01T00:00:00" 
                 wfstatustext="" 
                 description="" 
                 contentsize="0"
                 imagesavailable="0"
                 virtualpath="">
      <user createdby="John Oscar" />
    </document>
  <!-- more documents follow -->
  </documents>
</root>

The checkoutstatus attribute, specifies whether the document is checked out and if so, whether the document is checked out by the caller or someone else.

The publishstatus attribute, which is defined in the PublishStatuses enumeration, can have one of the following values and meaning

The revisionstatus attribute, can have one of the following values and meaning

When limited level is requested the following syntax is expected

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <pageno>1</pageno>
  <pagecount>1</pagecount>
  <recordcount>1</recordcount>
  <unitid>40</unitid>
  <parentid>561</parentid>
  <module>Dokument</module>
  <location>MyUnit/HTML/</location>
  <categoryid>561</categoryid>
  <isenabledforpdf>0</isenabledforpdf>
  <documents>
    <document id="4420" 
                 name="HelloCS5" 
                 type="text/html" 
                 modified="2007-02-28T15:27:57.323" 
                 filename="MyUnit/HTML/BCC7232E-BD9F-4112-9929-275EE7121204.aspx" 
                 deleteddate="1900-01-01T00:00:00" 
                 description=""/>
    <!-- more document elements follow -->
  </documents>
</root>

Note
In version 5.3 support for reading only the document deleted by the caller has been introduced as a new filter option.

Starting with version 5.3, programmers that write their own code to list documents in the recycling bin might like to use the alternative method GetDocumentsInRecyclingBin instead which is easier and more friendly to use.

Reference