WsGetReaderProperty function (webservices.h)

This function returns a property of the specified XML Reader.

Note  Obtaining the Property WS_XML_READER_PROPERTY_CHARSET will require inspecting up to the first four bytes of the XML data. Consequently if the Reader is using WS_XML_READER_STREAM_INPUT the WsFillReader function must be called first to ensure that this data has been read.

 

Syntax

HRESULT WsGetReaderProperty(
  [in]           WS_XML_READER             *reader,
  [in]           WS_XML_READER_PROPERTY_ID id,
                 void                      *value,
  [in]           ULONG                     valueSize,
  [in, optional] WS_ERROR                  *error
);

Parameters

[in] reader

A pointer to a WS_XML_READER object containing the desired property value.

[in] id

An enumerator value identifier of the Reader property.

value

A pointer to the address for returning the retrieved value. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

A byte count of the buffer that the caller has allocated for the retrieved value.

[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