XmlFilterFilterScalar 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 the Content Studio EPT Xml index and returns the identifier of the first document that matches the filter condition.

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

public int FilterScalar()

Return Value

Type: Int32
An Int32 that identifies the first matching document, zero if no match could be found.
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

This method is optimized for returning a single record only and has the following behavior For queries that return multiple records, use the FilterReader method that returns a XmlFilterReader object for optimized read-only, forward only access to the data.
See Also

Reference