XmlFilterFilterReader Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Performs the filter operation against Content Studio and returns an object that enables the caller to retrieve the data in an object oriented way.

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

public XmlFilterReader FilterReader()

Return Value

Type: XmlFilterReader
An XmlFilterReader a way of reading a forward-only stream of rows from the filtering operation.
Exceptions

ExceptionCondition
InvalidOperationExceptionCannot execute the Filter method without first initialize the connectionID and sessionID properties.
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

BROWSE permission on the documents selected is required if DraftsOnly is false otherwise READ permission is required. If permission on meta data is applied on the document category additional permissions on connected documents may apply.
Remarks

The Filter method does the same thing as the FilterReader method but returns data in the raw Xml format. Additionally, the FilterScalar and FilterScalar(String, String) methods provides easy and optimized ways of querying single record queries.
See Also

Reference