WsWriteAttribute function
Write a typed value as an XML attribute.
Syntax
HRESULT WINAPI WsWriteAttribute( _In_ WS_XML_WRITER* writer, _In_ const WS_ATTRIBUTE_DESCRIPTION* attributeDescription, _In_ WS_WRITE_OPTION writeOption, const void* value, _In_ ULONG valueSize, _In_opt_ WS_ERROR* error );
Parameters
- writer [in]
-
The writer to write the attribute to.
- attributeDescription [in]
-
A pointer to a description of how to serialize the attribute.
- writeOption [in]
-
Information about how the value is allocated. See WS_WRITE_OPTION for more information.
- value
-
A pointer to the value to serialize.
- valueSize [in]
-
The size of the value being serialized, in bytes.
If the value is NULL, then the size should be 0.
- 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. |
|
One or more arguments are invalid. |
|
Ran out of memory. |
Remarks
This API writes the start attribute, attribute value, and end attribute.
If the API fails, the state of input writer becomes undefined. The only APIs that may be used on the writer if this occurs are WsSetOutput and WsSetOutputToBuffer to return the writer to a usable state, or WsFreeWriter to free the writer.
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 |
|