WS_DECODER_GET_CONTENT_TYPE_CALLBACK callback function (webservices.h)

Article
02/22/2024

Gets the content type of the message.

Syntax

WS_DECODER_GET_CONTENT_TYPE_CALLBACK WsDecoderGetContentTypeCallback;

HRESULT WsDecoderGetContentTypeCallback(
  [in]           void *decoderContext,
  [in]           const WS_STRING *contentType,
  [in, optional] const WS_STRING *contentEncoding,
  [out]          WS_STRING *newContentType,
  [in, optional] WS_ERROR *error
)
{...}

Parameters

[in] decoderContext

The encoder instance returned by the WS_CREATE_DECODER_CALLBACK.

[in] contentType

The content type of the encoded message.

[in, optional] contentEncoding

The content encoding for the encoded message.

[out] newContentType

The callback should return the content type for the newly decoded message here.

[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 callback should verify that the content type provided matches what is expected, and then should return the content type of the decoded message.

The content type returned must remain valid until the next time the callback is invoked, or the decoder is freed.

The callback has to set newContentType to one that is supported by underlying channel. For example, with TCP session channel using SOAP 1.2 and binary encoding, the new content type should always be application/soap+msbinsession1.

For WS_HTTP_CHANNEL_BINDING the content encoding parameter will be set to the value of the "Content-Encoding" HTTP header. If this header does not exist, then NULL will be passed.

For all other channel bindings, NULL will be passed for the content encoding.

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

Share via