WsWriteValue function (webservices.h)

Article
02/22/2024

This operation derives the best representation for a primitive value from the underlying encoding and passes the derived value to a Writer object.

Note It is generally more efficient to use this function to write out primitive values rather than converting the value to text and subsequently using WsWriteChars.

Syntax

HRESULT WsWriteValue(
  [in]           WS_XML_WRITER *writer,
  [in]           WS_VALUE_TYPE valueType,
                 const void    *value,
  [in]           ULONG         valueSize,
  [in, optional] WS_ERROR      *error
);

Parameters

[in] writer

A pointer to the WS_XML_WRITER object to which the value is written. The pointer must reference a valid XML Writer object.

[in] valueType

Indicates the Type of primitive value referenced by the value parameter.

value

A void pointer to the primitive value.

[in] valueSize

The size in bytes of the value being written.

[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
E_INVALIDARG	One or more arguments are invalid.
WS_E_INVALID_OPERATION	The operation is not allowed due to the current state of the object.

Remarks

WsWriteValue may be called only once between WsWriteStartAttribute and WsWriteEndAttribute. It may not be combined with WsWriteChars, WsWriteBytes, WsWriteCharsUtf8 or WsWriteText when writing an attribute.

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