Skip to content

Latest commit

 

History

History
100 lines (81 loc) · 3.24 KB

nf-webservices-wsreadstartattribute.md

File metadata and controls

100 lines (81 loc) · 3.24 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:webservices.WsReadStartAttribute
WsReadStartAttribute function (webservices.h)
Moves the Reader to the specified attribute so that the content may be read using WsReadValue, WsReadChars, or WsReadBytes.
WsReadStartAttribute
WsReadStartAttribute function [Web Services for Windows]
webservices/WsReadStartAttribute
wsw.wsreadstartattribute
wsw\wsreadstartattribute.htm
wsw
6fd0c8c2-2eac-4d98-898d-1c5849220c36
12/05/2018
WsReadStartAttribute, WsReadStartAttribute function [Web Services for Windows], webservices/WsReadStartAttribute, wsw.wsreadstartattribute
webservices.h
Windows
Windows 7 [desktop apps \| UWP apps]
Windows Server 2008 R2 [desktop apps \| UWP apps]
WebServices.lib
WebServices.dll
Windows
19H1
WsReadStartAttribute
webservices/WsReadStartAttribute
c++
APIRef
kbSyntax
DllExport
WebServices.dll
WsReadStartAttribute

WsReadStartAttribute function

-description

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.

 

-parameters

-param reader [in]

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

-param attributeIndex [in]

The index of the attribute to read.

-param error [in, optional]

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

-returns

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.