Expand Minimize

WsWriteValue function

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 WINAPI  WsWriteValue(
  _In_      WS_XML_WRITER* writer,
  _In_      WS_VALUE_TYPE valueType,
  const void* value,
  _In_      ULONG valueSize,
  _In_opt_  WS_ERROR* error
);

Parameters

writer [in]

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

valueType [in]

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

I

value

A void pointer to the primitive value.

valueSize [in]

The size in bytes of the value being written.

error [in, optional]

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 codeDescription
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

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