The following table describes the XML elements and attributes.
Unless otherwise indicated, the data type is string.
| Element |
Description, relationships, and attributes |
| codePage
|
Description:
Specifies the code page of the request.
By default, the provider assumes that
incoming HTTP is encoded as UTF-8. If it is, the provider
automatically converts the HTTP to Unicode.
If the incoming stream is not UTF-8, you will have faster
performance if you specify the codePage value (for example,
"932" for Japanese). Alternately, you can set the provider to scan
for the code page (codePageAutoDetect = 1), but this will
slow down performance.
If the auto-detect is used, you can still specify a
codePage value as a backup in case the auto-detect
fails.
Parent:
RequestInfo, rollbackInfo
|
| codePageAutoDetect
|
Description:
Boolean that determines whether the provider automatically detects
the code page for the request.
0 (default): The provider does not automatically detect
the code page.
1: The provider invokes mlang.dll to scan the incoming HTTP stream
and convert it to Unicode.
By default, the provider assumes that incoming HTTP is encoded
as UTF-8. If it is, the provider automatically converts the HTTP to
Unicode, and there is no need to specify a value for
codePageAutoDetect.
If the incoming stream is not UTF-8, you can set the provider to
scan for the code page (codePageAutoDetect = 1), but note
that this will slow down performance. You will have better
performance if you specify the code page (for example, for
Japanese, set codePage to "932").
If the auto-detect fails, the provider looks for a
codePage value; if it does not find one, it converts the
HTTP to UTF-8, then to Unicode.
Parent:
requestInfo, rollbackInfo
|
| connectionExclusionInterval
|
Description:
UI4 that specifies the interval (milliseconds) for re-attempting a
failed connection with a server.
Whenever the provider cannot successfully send requests to a
server, it immediately places the server on a bad server list and
returns an error to indicate that the remote service is currently
unavailable. At periodic intervals (for example, every 50000
milliseconds), the provider re-attempts the connection.
This option mimimizes unnecessary resource consumption of
network bandwidth, CPU cycles, and other system resources during a
failure. It also enables the provider to generate a more immediate
error to alert the caller that the server is not available.
If no value is specified in the request for
connectionExclusionInterval, the provider uses the value for
the ConnectionExclusionInterval registry key, defined in
\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Provisioning\Providers\MPFSoapProv.
Note: The provider lists a server only for the
provisioning engine that executes the provider. Other engines will
not list the server unless they also fail to execute requests
against it.
Parents:
requestInfo, rollbackInfo |
| errorCodePath
|
Description:
Instead of returning an HRESULT based on the faultcode, a custom
XML path such as "detail/ErrorCode" can be used to specify where to
get the HRESULT within the soap:Fault node.
Parents:
requestInfo, rollbackInfo |
| executeData
|
Description:
Element that encapsulates the procedure's input and output data.
Children:
requestInfo (minOccurs="1" maxOccurs="1", input and
output)
rollbackInfo (minOccurs="1" maxOccurs="1", input
only) |
| method
|
Description:
Name of the method to invoke in the COM object.
Parents:
requestInfo, rollbackInfo
|
| parameters
|
Description:
Encapsulates input and output data for the request.
Parents:
requestInfo (input and output), rollbackInfo
Child:
parameter (minOccurs="0" maxOccurs="*", input and
output) |
| parameter
|
Description:
Optional input/output element.
If the parameter has multiple values, specify them using
value nodes. The following example sends the method a
VARIANT array of size two in which each VARIANT contains an
integer.
<parameter>
<value xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="int">1</value>
<value xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="int">2</value>
</parameter>
To send XML as a string, specify isXML ="1". The next
example sends the string value
<rootNode><value>1</value><value>2</value></rootNode>.
<parameter isXML="1">
<rootNode>
<value>1</value>
<value>2</value>
</rootNode>
</parameter>
Parent:
parameters
Attributes:
| arrayType
|
Optional. Indicates that the parameter is an array and
specifies the data type for all elements. If arrayType is
not specified and there are multiple values, the default is
"anyType," which means an array of VARIANT. On output, this
attribute is either set to the array type or removed ( if the
response is not an array). |
| isXML
|
Optional. On input, if parameter contains well- formed
XML, the method converts it to a string; otherwise, the provider
fails the request. On output, if the response is well-formed XML,
the method places this XML under the parameter element;
otherwise, it removes the isXML attribute and returns the
value in the response format. |
|
| password
|
Description:
User password that the Web server accepts for basic authentication.
Parents:
requestInfo, rollbackInfo
Maximum Length:
128 |
| port
|
Description:
Name of the port in the WSDL file that contains the operation
specified in the SOAP request. If this parameter is missing, null,
or an empty string, the provider uses the first port in the
specified service (serviceName node) when initializing the
SOAP client.
Parents:
requestInfo, rollbackInfo
|
| receiveTimeout
|
Description:
UI4 that specifies the timeout interval in milliseconds. If the Web
server does not return a response within the specified interval,
the provider automatically retries the request. If the Web server
does not return a response the second time within the specified
interval, the provider generates a timeout error. If the
retryTimes element is specified, that is the number of pairs
of requests that will be attempted.
The minimum value allowed is 1,000 and the maximum is 3,600,000.
If a value outside this range is specified, the provider will fail
with error c5000003. The default is 30,000.
Parent:
requestInfo, rollbackInfo
|
| requestInfo
|
Description:
Encapsulates the information the provider uses to send the WSDL
request.
Parent:
executeData
Children:
codePage (minOccurs="0" maxOccurs="1")
codePageAutoDetect (minOccurs="0" maxOccurs="1")
connectionExclusionInterval (minOccurs="0"
maxOccurs="1")
method (minOccurs="1" maxOccurs="1", input only)
parameters (minOccurs="1" maxOccurs="1", input and
output)
password (minOccurs="1" maxOccurs="1", input only)
port (minOccurs="1" maxOccurs="1", input only)
receiveTimeout (minOccurs="0" maxOccurs="1")
retryTimes (minOccurs="0" maxOccurs="1")
returnValue (minOccurs="0" maxOccurs="1", optional input,
required output)
serviceName (minOccurs="1" maxOccurs="1", input only)
userName (minOccurs="1" maxOccurs="1", input only)
wsdlFile (minOccurs="1" maxOccurs="1", input only)
wsmlFile (minOccurs="1" maxOccurs="1", input only) |
| retryTimes
|
Description:
UI4 that specifies the number of times the provider attempts to
resend the provisioning request whenever it experiences difficulty
establishing a connection to the Web server. A lower protocol layer
already performs one retry, so the retryTimes element
actually specifies how many extra pairs of retry attempts to
perform.
Parent:
requestInfo, rollbackInfo
|
| returnValue
|
Description:
Value returned by the WSDL request. The element is created if not
already there. The isXML attribute determines the format for
the returned value.
Parent:
requestInfo
Attributes:
| arrayType
|
Optional; output only. Specifies that the returned value is an
array and specifies the data type for all elements. This attribute
is either set to the array type or removed (if the response is not
an array). |
| isXML
|
Optional. If specified and the response is well- formed XML,
the method places the XML under the returnValue element;
otherwise, it removes the isXML attribute and returns the
value in the response format. |
|
| rollbackInfo
|
Description:
Encapsulates the transaction rollback information for the WSDL
request.
Parent:
executeData
Children:
codePage (minOccurs="0" maxOccurs="1")
codePageAutoDetect (minOccurs="0" maxOccurs="1")
connectionExclusionInterval (minOccurs="0"
maxOccurs="1")
method (minOccurs="1" maxOccurs="1", input only)
parameters (minOccurs="1" maxOccurs="1", input only)
password (minOccurs="0" maxOccurs="1", input only)
port (minOccurs="0" maxOccurs="1", input only)
receiveTimeout (minOccurs="0" maxOccurs="1")
retryTimes (minOccurs="0" maxOccurs="1")
serviceName (minOccurs="0" maxOccurs="1", input only)
userName (minOccurs="0" maxOccurs="1", input only)
wsdlFile (minOccurs="1" maxOccurs="1", input only)
wsmlFile (minOccurs="0" maxOccurs="1", input only) |
| serviceName
|
Description:
Service in the WSDL file that contains the operation specified in
the SOAP request. If this parameter is missing, null, or an empty
string, the provider uses the first service in the specified WSDL
file (wsdlFile node) when initializing the SOAP client.
Parents:
requestInfo, rollbackInfo
|
| userName
|
Description:
User name that the Web server accepts for basic authentication.
Parents:
requestInfo, rollbackInfo
Maximum Length:
128 |
| wsdlFile
|
Description:
URL of the WSDL file that describes the services offered by the
server.
If the WSDL URL uses the HTTPS protocol then the POST URLs in
the WSDL file must also use the HTTPS protocol.
Parents:
requestInfo, rollbackInfo
|
| wsmlFile
|
Description:
URL of a Web Services Meta Language (WSML) file. Required only when
using custom type mappers to convert between XML and COM data
types.
Parents:
requestInfo, rollbackInfo
|
|
Arguments