WsSetInput function

Sets the encoding and input sources for an XML Reader. These settings override settings made when the Reader was created.

Note If both encoding and input are NULL the reader will operate as if it is positioned at the end of an empty XML document.

Syntax

C++


HRESULT WINAPI  WsSetInput(
  _In_     WS_XML_READER*                reader,
  _In_opt_ const WS_XML_READER_ENCODING* encoding,
  _In_opt_ const WS_XML_READER_INPUT*    input,
           const WS_XML_READER_PROPERTY* properties,
  _In_     ULONG                         propertyCount,
  _In_opt_ WS_ERROR*                     error
);

Parameters

reader [in]

A pointer to the WS_XML_READER object for which the input will be set.

encoding [in, optional]

A to an encoding value that describes the format of the input bytes. This value should be one of:

input [in, optional]

A pointer to a WS_XML_READER_INPUT structure that indicates the reader type.

properties

An array reference of optional Reader properties.

propertyCount [in]

The number of properties.

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

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Security

See the Security section in XML Reader.

Remarks

When WsSetInput is used on the XML Reader, the reader will function in a forward only manner and the functions WsGetReaderPosition, WsSetReaderPosition and WsMoveReader cannot be used.

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