- Contents
SOAP Notifier COM API Developer's Guide
Using Microsoft SOAP Toolkit with ISoapConnector
Microsoft's SOAP Toolkit makes it possible for programmers to invoke a web service as easily as invoking a method on an object. The Microsoft SOAP Toolkit reads in a WSDL file, and dynamically generates COM interfaces for operations described in the file.
The SOAP Notifier COM API works cooperatively with Microsoft's SOAP Toolkit. The SOAP Notifier COM API provides a component named ISoapConnector that is used to initiate SOAP handlers using Microsoft SOAP Toolkit 2.0.
Using ISoapConnector (MSSOAP Notifier Connector)
ProgId: ININ.MSSOAPNotifierConnector
The VB example below shows how to use the transport. It is assumed that a WSDL file with the service description exists, since this is required for MSSOAPLib.SoapClient.
Using the Transport with Visual Basic 6
Dim objTransport As New SOAPNotifierCOMLib.SOAPNotifierTransport
objTransport.Connect "<Notifier>", "<AppId>", "<user>", "<password>", "<ClientName>"
Dim objClient As New MSSOAPLib.SoapClient
objClient.ClientProperty("ConnectorProgID") = "ININ.MSSOAPNotifierConnector"
objClient.mssoapinit "<WSDL filename or URL>"
objClient.ConnectorProperty("Transport") = objTransport
Result = objClient.<method>(<arguments>...)
Instead of the SoapClient, you may use the MSSOAPLib.SoapSerializer and MSSOAPLib.SoapReader objects with any object that uses a ISoapConnector.
SOAP Notifier Connector Properties
Transport
Transport object to be used for server communication. Must be set before the first invocation.
SOAPAction
SOAP Action used in the request. If not defined (empty string), uses value from the WSDL file.
InitiatorEvent
Initator Event (notification event) of the request notification. If not specified or as default, the SOAPAction is used. Changing the SOAPAction also resets this property, unless the PreserveInitiatorEvent property is set.
If the SOAPAction has never been set or is an empty string and the value from the WSDL file is used, the InitiatorEvent is reset after each request (again, unless PreserveInitiatorEvent is True).
PreserveInitiatorEvent
If True, changing the SOAPAction does not change the InitiatorEvent property.
RequestTimeout
Maximum amount of time to wait for response in milliseconds. Value < 0 à infinite. Default = 60000 (1 minute).
TransportInfo
Write only. Transport info data. Must be object implementing IStream.
TransportCtrl
Read only. Transport control data, returns IUnknown of an object implementing IStream. Can only be retrieved after invocation until the object using the connector calls the ‘BeginMessage' method of the connector (usually, as part of the next invocation).
ResponseObject
Read Only. Returns the ISOAPResponse object resulting from the request. Can only be retrieved after invocation until the object using the connector calls the ‘BeginMessage' method of the connector (usually, as part of the next invocation).