HttpClient.PostData Method (String, MemoryStream, MemoryStream, HttpPostOptions)

Submits the contents of the specified MemoryStream to a resource on the server.

[Visual Basic]
Overloads Public Function PostData( _
   ByVal resourceName As String, _
   ByVal requestStream As MemoryStream, _
   ByVal responseStream As MemoryStream, _
   ByVal options As HttpPostOptions _
) As Boolean

[C#]
public bool PostData(
   string resourceName,
   MemoryStream requestStream,
   MemoryStream responseStream,
   HttpPostOptions options
);

Parameters

resourceName: A string which specifies the resource on the server. The resource name should be specified using an absolute path which begins with a leading slash. character.
requestStream: A MemoryStream object which contains the data to be submitted to the server. This stream must be readable, otherwise a NotSupported exception will be thrown.
responseStream: A MemoryStream object which will contain the output from the server when the method returns. This stream must be readable and seekable, otherwise a NotSupported exception will be thrown.
options: An HttpPostOptions enumeration which specifies one or more options when submitting data to the server.

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 PostData method submits the contents of the specified MemoryStream to the web server and returns the result in another MemoryStream object provided by the caller. 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.

When encountering a server error during a request, the PostData method normally returns false, and no data is copied into the caller-provided MemoryStream. The LastError property is updated to reflect the general cause of the failure, allowing the application to handle this error condition appropriately. Additionally, servers may provide further details about the failure, such as XML or JSON formatted data containing specific error codes or diagnostic messages.

To capture this error information, you can utilize the postErrorData option. When this option is enabled, the behavior of PostData changes; it does not return false for server error statuses. Instead, any error data provided in the server's response, regardless of its format, is copied into the MemoryStream object provided by the caller.

HttpClient.PostData Method (String, MemoryStream, MemoryStream, HttpPostOptions)

Parameters

Return Value

Remarks

See Also