WsWriteAttribute 関数 (webservices.h)

  • [アーティクル]

型指定された値を XML 属性として書き込みます。

構文

HRESULT WsWriteAttribute(
  [in]           WS_XML_WRITER                  *writer,
  [in]           const WS_ATTRIBUTE_DESCRIPTION *attributeDescription,
  [in]           WS_WRITE_OPTION                writeOption,
                 const void                     *value,
  [in]           ULONG                          valueSize,
  [in, optional] WS_ERROR                       *error
);

パラメーター

[in] writer

属性を書き込むライター。

[in] attributeDescription

属性をシリアル化する方法の説明へのポインター。

[in] writeOption

値の割り当て方法に関する情報。 詳細については、「 WS_WRITE_OPTION 」を参照してください。

value

シリアル化する値へのポインター。

[in] valueSize

シリアル化される値のサイズ (バイト単位)。

値が NULL の場合、サイズは 0 にする必要があります。

[in, optional] error

関数が失敗した場合に追加のエラー情報を格納する場所を指定します。

戻り値

この関数は、これらの値のいずれかを返すことができます。

リターン コード 説明
WS_E_INVALID_FORMAT
 入力データの形式が正しくないか、予期した値が指定されていませんでした。
E_INVALIDARG
 1 つ以上の引数が無効です。
E_OUTOFMEMORY
 メモリ不足。

解説

この API は、start 属性、属性値、および end 属性を書き込みます。

API が失敗した場合、入力ライターの状態は未定義になります。 この場合にライターで使用できる API は、ライターを使用可能な状態に戻す 場合は WsSetOutput と WsSetOutputToBuffer のみ、ライターを解放するには WsFreeWriter だけです。

要件

   
サポートされている最小のクライアント Windows 7 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー webservices.h
Library WebServices.lib
[DLL] WebServices.dll