Windows Dev Center

Expand Minimize

WsReadChars function

Reads a specified number of text characters from the Reader.

Syntax


HRESULT WINAPI  WsReadChars(
  _In_     WS_XML_READER* reader,
           WCHAR*         chars,
  _In_     ULONG          maxCharCount,
  _Out_    ULONG*         actualCharCount,
  _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.

chars

A pointer to a location for the characters that have been read.

maxCharCount [in]

The maximum number of characters that should be read.

actualCharCount [out]

A pointer to a ULONG value of the actual number of characters that were read. This may be less than maxCharCount even when there are more characters remaining. There are no more characters 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.

Return codeDescription
WS_E_INVALID_FORMAT

The input data was not in the expected format or did not have the expected value.

WS_E_QUOTA_EXCEEDED

A quota was exceeded.

 

Remarks

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

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