WsGetXmlAttribute function

Finds the nearest xml attribute in scope with the specified localName and returns its value. The returned value is placed on the specified heap.

Syntax

HRESULT WINAPI  WsGetXmlAttribute(
  _In_     WS_XML_READER*       reader,
  _In_     const WS_XML_STRING* localName,
  _In_     WS_HEAP*             heap,
           WCHAR**              valueChars,
  _Out_    ULONG*               *valueCharCount,
  _In_opt_ WS_ERROR*            error
);

Parameters

reader [in]

The reader for which the xml attribute will be searched.

localName [in]

The localName of the xml attribute for which to search.

heap [in]

The heap on which the resulting value should be allocated.

valueChars

The value of the attribute is stored here.

valueCharCount [out]

The length of the valueChars.

error [in, optional]

Specifies where additional error information should be stored if the function fails.

Return value

This function can return one of these values.

Remarks

This function may only be used to obtain the values of attributes in scope that use the prefix "xml".

If no matching xml attribute is found, a zero length string will be returned for the value, and the function returns S_FALSE.

The reader does not do anything with xml attributes other than to surface them for inspection.

Requirements