WebServiceAdapterObject Interface

Definition

Namespace:

Microsoft.Office.Interop.InfoPath

Assembly:

Microsoft.Office.Interop.InfoPath.dll

Represents a connection to an XML Web service.

public interface class WebServiceAdapterObject : Microsoft::Office::Interop::InfoPath::WebServiceAdapter2

[System.Runtime.InteropServices.Guid("096CD5D4-0786-11D1-95FA-0080C78EE3BB")]
public interface WebServiceAdapterObject : Microsoft.Office.Interop.InfoPath.WebServiceAdapter2

type WebServiceAdapterObject = interface
    interface WebServiceAdapter2

Public Interface WebServiceAdapterObject
Implements WebServiceAdapter2

Derived

Microsoft.Office.Interop.InfoPath.WebServiceAdapterObjectClass

Attributes

GuidAttribute

Implements

WebServiceAdapter2

Examples

In the following example, a reference to the WebServiceAdapter object is set by using the QueryAdapter property of the DataSourceObject object by passing the name of the DataSourceObject object to the Item[Object] property of the DataObjectsCollection collection:

<span class="label">WebServiceAdapter2</span> wsAdapter2;

wsAdapter2 = (WebServiceAdapter2) thisXDocument.DataObjects["WebCityList"].QueryAdapter;

After the reference has been set, you can use the properties of the WebServiceAdapter object as shown in the following example, which sets a reference to the string returned by the Input property:

string input;
input = wsAdapter2.Input;

Note: In this case, the QueryAdapter property was used to access the Input property of the WebServiceAdapter object.

Remarks

This type is a wrapper for a coclass that is required by managed code for COM interoperability. Use this type to access the members of the COM interface implemented by this coclass. For information about the COM interface, including a link to descriptions of its members, seeWebServiceAdapter2.

The WebServiceAdapterObject object is a type of Microsoft Office InfoPath 2003 data adapter that contains all the information necessary for retrieving data from and submitting data to an external data source.

The WebServiceAdapterObject provides properties that can be used to get and set information about the data adapter's input and operation strings. It also provides a property for getting the Uniform Resource Locator (URL) of the Web Services Description Language (WSDL) file of the XML Web service.

For secondary data sources, the WebServiceAdapterObject object is accessible through the QueryAdapter property of the DataSourceObject object and the Item[Object] property of the DataAdaptersCollection. Data objects are accessible through the DataObjects property of the XDocument object.

If a Web service is used as the primary data source for a form, the WebServiceAdapterObject object is accessible through QueryAdapter property of the XDocument object

Properties

ErrorsLocation	Gets the XML Document Object Model (DOM) node under which the adapter will copy returned errors as XML. (Inherited from WebServiceAdapter2)
Input	Gets or sets the XML string ('outer XML') corresponding to the input element in the form definition (.xsf) file. (Inherited from WebServiceAdapter2)
Name	Gets the name of a WebServiceAdapterObject object. (Inherited from WebServiceAdapter2)
Operation	Gets or sets the XML string ('outer XML') corresponding to the operation element contained in the form definition (.xsf) file for the WebServiceAdapterObject object. (Inherited from WebServiceAdapter2)
OutputLocation	Gets the XML Document Object Model (DOM) node under which the adapter will copy the XML returned by the XML Web service. (Inherited from WebServiceAdapter2)
QueryAllowed	Corresponds to the queryAllowed attribute in the form definition file (.xsf). (Inherited from WebServiceAdapter2)
SubmitAllowed	Corresponds to the submitAllowed attribute in the form definition file (.xsf). (Inherited from WebServiceAdapter2)
Timeout	Gets or sets the time-out value in seconds for a WebServiceAdapterObject object. (Inherited from WebServiceAdapter2)
WSDLURL	Gets the Uniform Resource Locator (URL) of the Web Services Description Language (WSDL) file for the Web service associated with the WebServiceAdapterObject object. (Inherited from WebServiceAdapter2)

Methods

GenerateDataSetDiffGram(IXMLDOMNode)	Gets a serialized ADO.NET DataSet, containing an inline schema describing the data and the DataSet's DiffGram. (Inherited from WebServiceAdapter2)
Query()	Executes the query operation on the adapter, by invoking the specified Web method on the Web service, and inserting the returned XML under the dataFields node of the associated data source. (Inherited from WebServiceAdapter2)
Submit()	Executes the submit operation on the associated adapter. (Inherited from WebServiceAdapter2)