WsRequestReply function (webservices.h)

Article
10/13/2021

Used to send a request message and receive a correlated reply message.

Syntax

HRESULT WsRequestReply(
  [in]           WS_CHANNEL                   *channel,
  [in]           WS_MESSAGE                   *requestMessage,
  [in]           const WS_MESSAGE_DESCRIPTION *requestMessageDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *requestBodyValue,
  [in]           ULONG                        requestBodyValueSize,
  [in]           WS_MESSAGE                   *replyMessage,
  [in]           const WS_MESSAGE_DESCRIPTION *replyMessageDescription,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
  [in, optional] const WS_ASYNC_CONTEXT       *asyncContext,
  [in, optional] WS_ERROR                     *error
);

Parameters

[in] channel

The channel to do the request-reply operation on.

[in] requestMessage

The message object to use to send the request.

The message object should be in WS_MESSAGE_STATE_EMPTY or WS_MESSAGE_STATE_INITIALIZED.

[in] requestMessageDescription

The action field of the WS_MESSAGE_DESCRIPTION is used as the action header for the request message. This field may be NULL if no action is required.

The bodyElementDescription field of the WS_MESSAGE_DESCRIPTION is used to serialize the body of the request message. This field may be NULL if no body element is desired. See WsWriteBody for information about how the body is serialized according to the bodyElementDescription.

[in] writeOption

Whether the body element is required, and how the value is allocated. See WS_WRITE_OPTION for more information.

requestBodyValue

A pointer to the value to serialize in the body of the request object.

[in] requestBodyValueSize

The size of the request value being serialized, in bytes.

[in] replyMessage

The message object to use to receive the reply.

The message object should be in WS_MESSAGE_STATE_EMPTY.

[in] replyMessageDescription

The action field of the WS_MESSAGE_DESCRIPTION is used to verify the action header of the received reply message. This field may be NULL if no action is required. If NULL, the action header of the received message is ignored if present.

The bodyElementDescription field of the WS_MESSAGE_DESCRIPTION is used to deserialize the body of the reply message. This field may be NULL if no body element is desired. See WsReadBody for information about how the body is deserialized according to the bodyElementDescription.

[in] readOption

Whether the reply body element is required, and how to allocate the value. For more information, see WS_READ_OPTION and WsReadBody.

[in, optional] heap

The heap used to allocate deserialized reply body values. If the heap is not necessary for the given type, then this parameter can be NULL.

value

Where to store the deserialized values of the body.

The interpretation of this parameter depends on the WS_READ_OPTION.

If the bodyElementDescription of the reply WS_MESSAGE_DESCRIPTION is NULL, then this parameter is not touched. In this case, the parameter does not need to be specified.

[in] valueSize

The interpretation of this parameter depends on the WS_READ_OPTION.

[in, optional] asyncContext

Information on how to invoke the function asynchronously, or NULL if invoking synchronously.

[in, optional] error

Specifies where additional error information should be stored if the function fails.

Return value

This function can return one of these values.

Return code	Description
WS_E_ENDPOINT_FAULT_RECEIVED	The reply message contained a fault. The fault can be extracted from the WS_ERROR using WsGetErrorProperty.
WS_S_ASYNC	The asynchronous operation is still pending.
WS_E_OPERATION_ABORTED	The operation was aborted.
WS_E_INVALID_OPERATION	The operation is not allowed due to the current state of the object.
WS_E_ENDPOINT_NOT_FOUND	The remote endpoint does not exist or could not be located.
WS_E_ENDPOINT_ACCESS_DENIED	Access was denied by the remote endpoint.
WS_E_ENDPOINT_DISCONNECTED	The connection with the remote endpoint was terminated.
WS_E_ENDPOINT_FAILURE	The remote endpoint could not process the request.
WS_E_ENDPOINT_NOT_AVAILABLE	The remote endpoint is not currently in service at this location.
WS_E_ENDPOINT_TOO_BUSY	The remote endpoint is unable to process the request due to being overloaded.
WS_E_ENDPOINT_UNREACHABLE	The remote endpoint was not reachable.
WS_E_INVALID_ENDPOINT_URL	The endpoint address URL is invalid.
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
WS_E_OPERATION_TIMED_OUT	The operation did not complete within the time allotted.
WS_E_PROXY_ACCESS_DENIED	Access was denied by the HTTP proxy server.
WS_E_PROXY_FAILURE	The HTTP proxy server could not process the request.
WS_E_QUOTA_EXCEEDED	A quota was exceeded.
WS_E_SECURITY_VERIFICATION_FAILURE	Security verification was not successful for the received data.
WS_E_SECURITY_SYSTEM_FAILURE	A security operation failed in the Windows Web Services framework.
WS_E_SECURITY_TOKEN_EXPIRED	A security token was rejected by the server because it has expired.
WS_E_PROXY_REQUIRES_BASIC_AUTH	The HTTP proxy server requires HTTP authentication scheme 'basic'.
WS_E_PROXY_REQUIRES_DIGEST_AUTH	The HTTP proxy server requires HTTP authentication scheme 'digest'.
WS_E_PROXY_REQUIRES_NEGOTIATE_AUTH	The HTTP proxy server requires HTTP authentication scheme 'negotiate'.
WS_E_PROXY_REQUIRES_NTLM_AUTH	The HTTP proxy server requires HTTP authentication scheme 'NTLM'.
WS_E_SERVER_REQUIRES_BASIC_AUTH	The remote endpoint requires HTTP authentication scheme 'basic'.
WS_E_SERVER_REQUIRES_DIGEST_AUTH	The remote endpoint requires HTTP authentication scheme 'digest'.
WS_E_SERVER_REQUIRES_NEGOTIATE_AUTH	The remote endpoint requires HTTP authentication scheme 'negotiate'.
WS_E_SERVER_REQUIRES_NTLM_AUTH	The remote endpoint requires HTTP authentication scheme 'NTLM'.
CERT_E_EXPIRED	A required certificate is not within its validity period when verifying against the current system clock or the timestamp in the signed file.
CERT_E_CN_NO_MATCH	The certificates CN name does not match the passed value.
CERT_E_UNTRUSTEDROOT	A certificate chain processed, but terminated in a root certificate which is not trusted by the trust provider.
CERT_E_WRONG_USAGE	The certificate is not valid for the requested usage.
CRYPT_E_REVOCATION_OFFLINE	The revocation function was unable to check revocation because the revocation server was offline.
E_OUTOFMEMORY	Ran out of memory.
E_INVALIDARG	One or more arguments are invalid.
Other Errors	This function may return other errors not listed above.

Remarks

The messages are correlated as appropriate to the WS_ADDRESSING_VERSION. See Channel Layer Overview for more information about correlating request reply messages.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	webservices.h
Library	WebServices.lib
DLL	WebServices.dll

Share via