Expand Minimize

WsWriteCharsUtf8 function

Writes a series of characters encoded as UTF-8 to an element or attribute. To write characters to an attribute value, call WsWriteStartAttribute first. Only whitespace characters may be written at the root of an xml document unless the WS_XML_WRITER_PROPERTY_ALLOW_FRAGMENT has been set to TRUE.

Syntax


HRESULT WINAPI  WsWriteCharsUtf8(
  _In_      WS_XML_WRITER* writer,
  const BYTE* bytes,
  _In_      ULONG byteCount,
  _In_opt_  WS_ERROR* error
);

Parameters

writer [in]

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

bytes

A pointer to the encoded UTF-8 characters to write.

byteCount [in]

The number of bytes to write.

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

WsWriteCharsUtf8 can be called more than once between WsWriteStartAttribute and WsWriteEndAttribute. It cannot be combined with WsWriteChars, WsWriteBytes, WsWriteValue 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:
© 2014 Microsoft