WsReadStartAttribute function (webservices.h)

Article
2024-02-22

Moves the Reader to the specified attribute so that the content may be read using WsReadValue, WsReadChars, or WsReadBytes.

If the reader is not positioned on a start element then it returns a WS_E_INVALID_FORMAT exception.

(See Windows Web Services Return Values.)

Note Attributes read do not appear in any particular order. WsFindAttribute can be used to locate the index of a particular attribute.

Syntax

HRESULT WsReadStartAttribute(
  [in]           WS_XML_READER *reader,
  [in]           ULONG         attributeIndex,
  [in, optional] WS_ERROR      *error
);

Parameters

[in] reader

A pointer to the XML Reader object used to read the Start attribute.

[in] attributeIndex

The index of the attribute to read.

[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
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.

Remarks

The WsReadNode function returns EOF when advanced within an attribute. The WsReadEndAttribute function can be used to return the reader to the containing element.

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

Share via