Microsoft.SharePoint.Dsp

Used in a query to specify that all the fields be returned from the data source.

Initializes a new instance of the class.

Gets or sets a Boolean value that specifies whether hidden fields are included in the query.

true if hidden fields are included in the query; otherwise, false. The default value is false.

The Authentication class represents the authentication mode that is used to connect to the back-end server.

Initializes a new instance of the class.

A string that contains the ID. A string that specifies the password.

Gets or sets the authentications specified in the authentication header.

A System.Xml.XmlElement array that specifies the authentications.

Indicates the type of XML format used for data returned in a query.

Element-centric.

Attribute-centric.

Represents a connection to a data retrieval service adapter.

Initializes a new instance of the class.

A string that contains the connection string.

Gets or sets the connection string for the connection.

A string that contains the connection string.

Represents the root of the content document for a particular adapter instance.

Initializes a new instance of the class.

Initializes a new instance of the class based on the specified data root.

A string that specifies the data root.

Gets or sets a Boolean value that specifies whether the adapter accesses data that resides on a different server.

true if the adapter is allowed to attempt access to remote data using the credentials supplied by the client; otherwise, false. The default value is true.

Gets or sets a string that identifies the data root for a particular adapter instance.

A string that specifies the data root. In the case of a Microsoft SQL Server adapter, this property contains the SQL Server name. In the case of a Microsoft Windows SharePoint Services adapter, this property contains the URL for the SharePoint site.

Specifies the document type for a request.

Service-specific document that represents data stored in the back-end data source. The schema for this document is a function of the schema of the data source. For example, in the case of the adapter service for Microsoft Windows SharePoint Services, the content document represents data stored on the SharePoint Web site where the service instance resides.

Service-specific document that contains system data. Clients may query the system document using standard methods to obtain data about the service, including supported authentication modes, the data root format of the adapter, supported query types, and version support.

Defines the filter used in a query against a data source provider.

Initializes a new instance of the class.

Gets or sets the fields that are included in the query.

A object that contains the fields.

Gets or sets the columns by which the data returned is ordered.

An array of objects representing the columns.

Gets or sets a limit for the number of rows returned in the query.

A 64-bit integer that specifies the row limit.

Gets or sets server parameter information in a query.

A object that contains the server parameter information.

Gets or sets the server parameters required by the data source in the query.

A array that contains the server parameters.

Gets or sets the Where clause used in the filter for the query.

A System.Xml.XmlNode object that contains the Where clause used in the query in the following form: Copy Code<Where> <And> <Or> <Eq> <FieldRef Name="Region"/> <Value>BC</Value> </Eq> <Eq> <FieldRef Name="Region"/> <Value>OR</Value> </Eq> </Or> <IsNotNull> <FieldRef Name="Phone"/> </IsNotNull> </And> </Where>

Represents a query used by a data retrieval service.

Initializes a new instance of the class.

Gets or sets the XML format that is used for data returned in the query.

A value that specifies the XML format.

Gets or sets the locale that the server uses for string comparisons.

A string that contains the locale ID (LCID).

Gets or sets the filter, column selection, sorting, and row limit used in the query.

A object that specifies the filter, column selection, sorting, and row limit.

Gets a Boolean value that indicates whether the property has been set.

true if the property has been set; otherwise, false.

Gets or sets the type of content that is returned through the query.

A value that specifies the type of content. The default value is Both.

Gets or sets the namespace to use on the query result.

A string that specifies the namespace.

Gets or sets a prefix for the result namespace.

A string that contains the prefix.

Gets or sets the root name for the XML payload.

A string that contains the root name.

Gets or sets a row element name for the XML payload.

A string that specifies the row element name.

Gets or sets an XPath expression that specifies the data item that the client is querying against.

A string that contains the XPath expression that specifies the data item. This value may be a non-row-returning item, such as a Microsoft SQL Server database or a Microsoft Windows SharePoint Services site, in which the query is a metadata query; or a row-returning item such as a SQL Server table or a Windows SharePoint Services view, in which case the query is a data query.

Gets or sets a string that identifies the beginning of the next page when paging is supported by the data retrieval service.

A string that identifies the beginning of the next page.

Represents a single column in a query.

Initializes a new instance of the class.

Initializes a new instance of the class based on the specified column name and column display name.

A string that contains the name of the column. A string that contains the display name of the column.

Gets or sets the display name of the column.

A string that contains the display name of the column.

Gets or sets the name of the column.

A string that contains the name of the column.

Represents the collection of columns that are included in a query.

Initializes a new instance of the class.

Initializes a new instance of the class that includes all the columns in a Microsoft Windows SharePoint Services list.

A object that specifies all the columns.

Initializes a new instance of the class based on the specified collection of columns.

An array of objects that specifies the columns.

Gets or sets all columns included in the query.

A object that represents all the columns.

Gets or sets the columns included in a query.

An array of objects that represents the columns.

Provides a COM interface for clients to access a data retrieval service adapter locally.

Gets or sets the authentication mode that is used to connect to the back-end server.

An object that specifies the authentication mode. When query execution finishes, this property contains the actual authentication method used to access the back-end server by the adapter.

Gets or sets the connection to the data retrieval service adapter.

A object that represents the connection.

Gets or sets the root of a particular data source.

A object that represents the root of the data source. The root format can be one of the following three forms: a server name, a UNC share, or a URL. When query execution finishes, the adapter resets this property to null.

Gets or sets a Boolean value that specifies whether the client is a server component that loads the adapter through the object model interface of the adapter.

true if the client is a server component that loads the adapter through the object model interface. The default value is false, indicating that the request arrives through SOAP.

Executes a query expressed as a predefined request object.

A object that contains the data in response to the request query.

Gets or sets the operation type and the document type of the query.

A object that specifies the operation type and the document type of the query. The only supported operation type is query. The document type can be either content or system.

Gets or sets the versions of the data retrieval service that are supported by the adapter or the versions being used by the client to query against the service.

A object that specifies the versions of the data retrieval service. When query execution finishes, this property contains the versions supported by the adapter.

Specifies the action of the request.

Represents a query.

The OrderDirection enumeration specifies the direction in which a field or column is sorted.

Specifies ascending sort.

Specifies descending sort.

Represents the column by which the result is ordered.

Initializes a new instance of the class.

Initializes a new instance of the class based on the specified column name and sort direction.

A string that contains the name of the column. A value that specifies the sort direction.

Gets or sets the sort direction for the column by which the result is ordered.

A value that specifies the sort direction.

Gets or sets the name of the column by which the result is ordered.

A string that contains the name of the column.

Indicates the type of paging that is supported for a query.

Indicates paging is not supported.

Indicates paging only moves forward.

Indicates paging can move forward or backward.

Represents a pass-through query.

Initializes a new instance of the class.

Gets or sets a placeholder where the content of the pass-through query is specified.

A System.Xml.XmlNode array whose structure each adapter defines.

Represents the request in a query.

Initializes a new instance of the class.

Gets or sets the data retrieval service query for the request.

A object that represents the query.

Gets or sets the pass-through query for the request.

A object that represents the pass-through query.

Represents the response in a query.

Initializes a new instance of the class.

Gets or sets the response for the data retrieval service query.

A object that represents the response.

Gets or sets the response for the pass-through query.

A object that represents the response.

Specifies a type of query that is used in a request.

Specifies data retrieval service query format.

Specifies Pass-Through query format.

Represents the request header in a query, containing information about the operation type and the document type of the query.

Initializes a new instance of the class.

Gets or sets an XPath expression that specifies the data item that the client is querying against.

Represents the request header in a query.

Initializes a new instance of the class.

Initializes a new instance of the class based on the specified document type and action.

A value that specifies the document type. A value that specifies the action.

Gets or sets the document type of the request.

A value that specifies the document type.

Gets or sets the action of the request.

A value that specifies the action of the request.

Represents the response in a query.

Initializes a new instance of the class.

Initializes a new instance of the class based on the specified XML data.

A string that contains the XML data.

Gets or sets the XML data of the response.

A string that contains the XML data in the following form: If the schema was requested in the property, the first top-level element is the XML schema (XSD), starting with the <schema> element.If the data was requested in the ResultContent property, the next top-level element is the data.The final top-level element is the pagingInfo element, which corresponds to the PagingInfo block. The XML string can then be set to the startPosition property to get the next page of data.

Gets or sets an error message for the response.

A string that contains the error message.

Gets or sets the response status of the query.

A value that specifies the response status.

Specifies the status of a query response.

Indicates the query succeeded.

Indicates the query failed.

Indicates the type of content that is returned through a query.

Returns both the schema (XSD) and XML payload parts of the query result.

Returns only the schema (XSD) part of the query result.

Returns only the XML payload part of the query result.

Represents a server parameter required by the server containing the data source.

Initializes a new instance of the class.

Initializes a new instance of the class based on the specified parameter name, parameter value, and a Boolean value specifying whether the value of the parameter is null.

A string that contains the name of the parameter. A string that contains the value of the parameter. true to specify that the value of the parameter is null; false to specify that the value of the server parameter be interpreted as an empty string ("").

Gets or sets the name of the server parameter.

A string that contains the name.

Gets or sets a Boolean value that specifies whether the value of the server parameter is null.

true to specify that the value of the parameter is null; false to specify that the value of the server parameter will be interpreted as an empty string ("").

Gets or sets the value of the server parameter.

A string that contains the value.

Represents information about the parameters used by the server containing the data source.

Initializes a new instance of the class.

Represents the versions of the data retrieval service that are supported by an adapter or the versions being used in a query.

Initializes a new instance of the class.

Initializes a new instance of the class based on the specified version.

A string array that specifies the version of the data retrieval service.

Gets or sets a version within the collection of versions supported by the data retrieval service adapter.

A string array that contains the version information.