XmlFilterFilter 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 return data as Xml

Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public override string Filter()

Return Value

Type: String
Xml.

The xml format depends on which fields are returned.

Copy
<root>
  <status>0</status>
  <statustext>Success</statustext>
  <pageno>1</pageno>
  <pagesize>5</pagesize>
  <pagecount>1</pagecount>
  <recordcount>1</recordcount>
  <rows>
    <row documentid="1242" Introduction="Content Studio 5 " Header="Web Content Management easier that ever!" />
    <!-- more row items can follow -->
  </rows>
</root>
Note that the number of attributes in the row element is depending on the number of fields returned.
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 property 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 FilterReader method does the same thing as the Filter method but returns an object to work with. Additionally, the FilterScalar and FilterScalar(String, String) methods provides an optimized ways of performing query operations that only return a single result.
See Also

Reference

XmlFilter Class
ContentStudio.Document.EPT Namespace
XmlFilterFilterReader
XmlFilterFilterScalar
XmlFilterFilterScalar(String, String)