WsCreateWriter 関数 (webservices.h)
は、指定されたプロパティを使用して XML ライター を作成します。
構文
HRESULT WsCreateWriter(
const WS_XML_WRITER_PROPERTY *properties,
[in] ULONG propertyCount,
WS_XML_WRITER **writer,
[in, optional] WS_ERROR *error
);
パラメーター
properties
XML ライターの省略可能なプロパティを含む WS_XML_WRITER_PROPERTY 構造体の配列。
このパラメーターの値は NULL である可能性があります。この場合、 propertyCount パラメーターは 0 (ゼロ) である必要があります。
[in] propertyCount
プロパティ配列内の プロパティ の数。
writer
成功した場合、作成された XML ライターを表す WS_XML_WRITER 構造体のアドレスを受け取るポインター。
この構造体が不要になった場合は、 WsFreeWriter を呼び出して解放する必要があります。
[in, optional] error
関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。
戻り値
関数が成功した場合は、NO_ERRORを返します。それ以外の場合は、HRESULT エラー コードを返します。
リターン コード | 説明 |
---|---|
|
1 つ以上の引数が無効です。 |
注釈
WSSetOutput 関数または WsSetOutputToBuffer 関数を使用して、XML ライターのエンコードを選択し、出力の転送先を指定します。
WS_XML_WRITERは、WsSetOutput またはWsSetOutputToBuffer をもう一度呼び出すことで再利用できます。
ライター の 構成に使用できるプロパティについては、「WS_XML_WRITER_PROPERTY_ID」を参照してください。
XML ライターは、 WsFlushWriter が呼び出されるまで、すべてのデータをバッファーに格納します。 これにより、呼び出し元は、データを書き込む粒度と、そのデータを非同期に書き込むかどうかを判断できます。 WsFlushWriter が呼び出されるまで、データは書き込まれません。
WS_XML_WRITERに対する操作が失敗した場合、ライターはエラー状態のままになり、ライターをさらに呼び出すと、WS_E_OBJECT_FAULTEDが返されます。 ( 「Windows Web Services の戻り値」を参照してください)。これが発生した場合に XML ライターに対して可能な関数呼び出しは、XML ライターを使用可能な状態に戻す WsSetOutput と WsSetOutputToBuffer 、または XML ライターを解放するための WsFreeWriter のみです。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 7 [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2008 R2 [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | webservices.h |
Library | WebServices.lib |
[DLL] | WebServices.dll |