Windows Dev Center

Expand Minimize

WsGetReaderProperty function

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 WINAPI  WsGetReaderProperty(
  _In_     WS_XML_READER*            reader,
  _In_     WS_XML_READER_PROPERTY_ID id,
           void*                     value,
  _In_     ULONG                     valueSize,
  _In_opt_ WS_ERROR*                 error
);

Parameters

reader [in]

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

id [in]

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.

valueSize [in]

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

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.

Return codeDescription
E_INVALIDARG

The property id was not supported for this object or the specified buffer was not large enough for the value.

 

Requirements

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

WebServices.h

Library

WebServices.lib

DLL

WebServices.dll

 

 

Community Additions

ADD
Show:
© 2015 Microsoft