IDspAdapter Interface
The IDspAdapter interface provides a COM interface for clients to access a data retrieval service adapter locally.
Public Methods
The following table shows the public methods of the IDspAdapter interface and a brief description of each.
| Name | Description |
|---|---|
| Query | Executes a query expressed as a predefined request object. |
Public Properties
The following table shows the public properties of the IDspAdapter interface, the data type of each property, and a brief description of each.
| Name | Data type | Description |
|---|---|---|
| Authentication | Microsoft.SharePoint.Dsp.Authentication | Gets or sets which authentication mode is used to connect to the back-end server. |
| Connection | Microsoft.SharePoint.Dsp.Connection | Gets or sets the connection to the data retrieval service adapter. |
| DataRoot | Microsoft.SharePoint.Dsp.DataRoot | Gets or sets the root of a particular data source. |
| LocalClient | Boolean | 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. |
| Request | Microsoft.SharePoint.Dsp.RequestHeader | Gets or sets the operation type and the document type of the query. |
| Versions | Microsoft.SharePoint.Dsp.Versions | 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. |
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Remarks
The IDspAdapter interface provides the interface definition that is implemented by the DspAdapter class in the namespace for each adapter:
- Microsoft.SharePoint.Dsp.OleDb for queries against OleDB data sources.
- Microsoft.SharePoint.Dsp.SoapPT for pass-through queries against Web services.
- Microsoft.SharePoint.Dsp.Sts for queries agains SharePoint lists.
- Microsoft.SharePoint.Dsp.XmlUrl for queries against XML sources.
Each data retrieval service adapter supports the methods defined in this interface. Local clients that use direct COM to access the adapter can call methods of the IDspAdapter interface directly.
Requirements
Namespace: Microsoft.SharePoint.Dsp
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Dsp (in Microsoft.SharePoint.Dsp.dll)
Security: Code Access Security