WsReadAttribute
TOC
Collapse the table of content
Expand the table of content

WsReadAttribute function

Read an attribute producing a value of the specified WS_TYPE.

Syntax


HRESULT WINAPI  WsReadAttribute(
  _In_     WS_XML_READER*                  reader,
  _In_     const WS_ATTRIBUTE_DESCRIPTION* attributeDescription,
  _In_     WS_READ_OPTION                  readOption,
  _In_opt_ WS_HEAP*                        heap,
           void*                           value,
  _In_     ULONG                           valueSize,
  _In_opt_ WS_ERROR*                       error
);

Parameters

reader [in]

The reader that is positioned on the element containing the attribute.

attributeDescription [in]

A pointer to a description of how to deserialize the attribute.

readOption [in]

Whether the attribute is required, and how to allocate the value. See WS_READ_OPTION for more information.

heap [in, optional]

The heap to store the deserialized values in.

value

The interpretation of this parameter depends on the WS_READ_OPTION.

valueSize [in]

The interpretation of this parameter depends on the WS_READ_OPTION.

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.

Return codeDescription
WS_E_INVALID_FORMAT

The input data was not in the expected format or did not have the expected value.

E_OUTOFMEMORY

Ran out of memory.

WS_E_QUOTA_EXCEEDED

The size quota of the heap was exceeded.

E_INVALIDARG

One or more arguments are invalid.

 

Remarks

This API will search for the attribute given the name and namespace, and then and deserialize the content as a typed value.

If the API fails, the state of input reader becomes undefined. The only APIs that may be used on the reader if this occurs are WsSetInput and WsSetInputToBuffer to return the reader to a usable state, or WsFreeReader to free the reader.

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:
© 2016 Microsoft