Edit

WS_ENCODER_START_CALLBACK callback function (webservices.h)

  • Article

Starts encoding a message.

Syntax

WS_ENCODER_START_CALLBACK WsEncoderStartCallback;

HRESULT WsEncoderStartCallback(
  [in]           void *encoderContext,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR *error
)
{...}

Parameters

[in] encoderContext

The encoder instance returned by the WS_CREATE_ENCODER_CALLBACK.

[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

Return code Description
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 encoder can use the callback passed to WS_CREATE_ENCODER_CALLBACK to write the encoded data of the message.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header webservices.h