WsGetWriterProperty function

Retrieves a specified XML Writer property. The property to retrieve is identified by a WS_XML WRITER_PROPERTY_ID input parameter.

Syntax

HRESULT WINAPI  WsGetWriterProperty(
  _In_     WS_XML_WRITER*            writer,
  _In_     WS_XML_WRITER_PROPERTY_ID id,
           void*                     value,
  _In_     ULONG                     valueSize,
  _In_opt_ WS_ERROR*                 error
);

Parameters

writer [in]

A pointer to a WS_XML_WRITER structure that contains the property value to retrieve.

id [in]

This is a WS_XML_WRITER_PROPERTY_ID enumerator that identifies the property to retrieve.

value

A void pointer to a location for storing the retrieved property value.

valueSize [in]

The byte-length buffer size allocated by the caller to store the retrieved property value. The pointer must have an alignment compatible with the type of the property.

error [in, optional]

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.

Requirements