HttpClient.PostXml Method (String, String, String)

Submits XML formatted data to the server and returns the result in a string.

[Visual Basic]
Overloads Public Function PostXml( _
   ByVal resourceName As String, _
   ByVal xmlData As String, _
   ByRef responseData As String _
) As Boolean

[C#]
public bool PostXml(
   string resourceName,
   string xmlData,
   ref string responseData
);

Parameters

resourceName: A string that specifies the resource on the server that the data will be posted to. Typically this is the name of an executable script on the server. The resource name should be specified using an absolute path that begins with a leading slash character.
xmlData: A string that contains the XML formatted data which will be provided to the script.
responseData: A string passed by reference that will contain the output generated by the script. Typically this is HTML content which is generated by the script as a result of processing the data that was posted to it.

Return Value

This method returns a Boolean value. If the method succeeds, the return value is true. If the method fails, the return value is false. To get extended error information, check the value of the LastError property.

Remarks

The PostXml method is used to submit XML formatted data to a script that executes on the server and then copy the output from that script into a local buffer. This function automatically sets the correct content type and encoding required for submitting XML data to a server, however it does not parse the XML data itself to ensure that it is well-formed. Your application is responsible for ensuring that the XML data that is being submitted to the server is formatted correctly.

This method will cause the current thread to block until the operation completes, a timeout occurs or the post is canceled. During the operation, the OnProgress event will fire periodically, enabling the application to update any user interface objects such as a progress bar.

HttpClient.PostXml Method (String, String, String)

Parameters

Return Value

Remarks

See Also