Edit

Share via

WsGetWriterProperty function (webservices.h)

  • Article

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

Syntax

HRESULT WsGetWriterProperty(
  [in]           WS_XML_WRITER             *writer,
  [in]           WS_XML_WRITER_PROPERTY_ID id,
                 void                      *value,
  [in]           ULONG                     valueSize,
  [in, optional] WS_ERROR                  *error
);

Parameters

[in] writer

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

[in] id

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.

[in] valueSize

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.

[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
 The property id was not supported for this object or the specified buffer was not large enough for the value.

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