WsReadCharsUtf8 function

Reads a specified number of text characters from the reader and returns them encoded in UTF-8.

Syntax

HRESULT WINAPI  WsReadCharsUtf8(
  _In_     WS_XML_READER* reader,
           BYTE*          bytes,
  _In_     ULONG          maxByteCount,
  _Out_    ULONG*         actualByteCount,
  _In_opt_ WS_ERROR*      error
);

Parameters

reader [in]

A pointer to the XML Reader from which the character data should be read. The pointer must reference a valid WS_XML_READER object.

bytes

A pointer to the buffer to place the encoded bytes that have been read.

maxByteCount [in]

The maximum number of bytes that should be read.

actualByteCount [out]

A pointer to a ULONG value of the actual number of bytes that were read. This may be less than maxByteCount even when there are more bytes remaining. There are no more bytes when this returns zero.

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.

Remarks

XML text is read up to either a start element or end element. Comments are skipped, and CDATA content is treated identically to element content. Character entities are converted to their unescaped form.

This function can fail for any of the reasons listed in WsReadNode.

Requirements