WsCreateReader 関数 (webservices.h)

指定したプロパティを使用して XML リーダー を作成します。

構文

HRESULT WsCreateReader(
                 const WS_XML_READER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_READER                **reader,
  [in, optional] WS_ERROR                     *error
);

パラメーター

properties

XML リーダーの省略可能なプロパティを含む WS_XML_READER_PROPERTY 構造体の配列。

このパラメーターの値は NULL にすることができます。この場合、 propertyCount パラメーターは 0 (ゼロ) である必要があります。

XML リーダーの構成に tiy が使用できるプロパティについては、 WS_XML_READER_PROPERTY_ID 列挙体を参照してください。

[in] propertyCount

プロパティ配列内の プロパティ の数。

reader

成功した場合、新しい XML リーダーを表す WS_XML_READER 構造体のアドレスを受け取るポインター。

この構造体が不要になった場合は、 WsFreeReader を呼び出して解放する必要があります。

[in, optional] error

関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。

戻り値

関数が成功すると、NO_ERRORが返されます。それ以外の場合は、HRESULT エラー コードが返されます。

注釈

WsSetInput 関数または WsSetInputToBuffer 関数を使用して、XML リーダーのエンコードを選択し、入力のソースを示します。

wsSetInput 関数に渡されるWS_XML_READER_INPUT構造体でWS_READ_CALLBACKが指定されている場合、XML リーダーは WsFillReader が呼び出されたときにのみ追加データを読み取ります。 これにより、呼び出し元は、データを読み取る粒度と、そのデータを非同期に読み取るかどうかを判断できます。

WS_XML_READER構造体は、WsSetInput または WsSetInputToBuffer をもう一度呼び出すことによって再利用できます。

WS_XML_READERで動作する API 操作が失敗した場合、XML リーダーはエラー状態のままになり、それ以降の関数呼び出しはWS_E_OBJECT_FAULTEDを返します。 ( 「Windows Web サービスの戻り値」を参照してください)。この場合、XML リーダーに対して可能な関数呼び出しは、XML リーダーを使用可能な状態に戻す 場合の WsSetInput と WsSetInputToBuffer 、または XML リーダー オブジェクトを解放するための WsFreeReader のみです。

要件