WsReadElement function
Read an element producing a value of the specified WS_TYPE.
Syntax
HRESULT WINAPI WsReadElement( _In_ WS_XML_READER* reader, _In_ const WS_ELEMENT_DESCRIPTION* elementDescription, _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 XML to deserialize.
- elementDescription [in]
-
A pointer to a description of how to deserialize the element.
- readOption [in]
-
Whether the element 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 code | Description |
|---|---|
|
The input data was not in the expected format or did not have the expected value. |
|
Ran out of memory. |
|
The size quota of the heap was exceeded. |
|
One or more arguments are invalid. |
Remarks
This API will move to the next element, verify its 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 |
|
|
Library |
|
|
DLL |
|