WsEndWriterCanonicalization function (webservices.h)

Article
02/22/2024

This function stops XML canonicalization started by the preceding WsStartWriterCanonicalization call. Remaining canonical bytes buffered by the writer are written to the callback function.

Syntax

HRESULT WsEndWriterCanonicalization(
  [in]           WS_XML_WRITER *writer,
  [in, optional] WS_ERROR      *error
);

Parameters

[in] writer

A pointer to a WS_XML_WRITER object on which canonicalization should be stopped.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Return code	Description
E_INVALIDARG	One or more arguments are invalid.
WS_E_INVALID_OPERATION	The operation is not allowed due to the current state of the object.

Remarks

WsEndWriterCanonicalization must be called at the same depth at which WsStartWriterCanonicalization was called.

It is not necessary to call WsEndWriterCanonicalization in order to call WsFreeWriter.

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