次の方法で共有

WsSetFaultErrorDetail 関数 (webservices.h)

  • [アーティクル]

WS_ERROR オブジェクトに格納されているエラーの詳細を書き込みます。

構文

HRESULT WsSetFaultErrorDetail(
  [in] WS_ERROR                          *error,
  [in] const WS_FAULT_DETAIL_DESCRIPTION *faultDetailDescription,
  [in] WS_WRITE_OPTION                   writeOption,
       const void                        *value,
  [in] ULONG                             valueSize
);

パラメーター

[in] error

エラー情報を格納するエラー オブジェクト。

[in] faultDetailDescription

エラーの詳細の説明へのポインター。

エラー詳細説明のアクション フィールドが NULL 以外の場合は、WS_ERRORのWS_FAULT_ERROR_PROPERTY_ACTIONとして設定されます。

障害の詳細の説明の要素の説明では、エラーの詳細の要素の形式が記述されています。

[in] writeOption

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

value

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

[in] valueSize

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

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

戻り値

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

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

注釈

この API は、WS_ERROR オブジェクトに格納されているWS_FAULTの詳細フィールドの値をシリアル化します。

この関数は、指定された WS_FAULT_DETAIL_DESCRIPTIONのWS_ELEMENT_DESCRIPTION の内容に基づいて、次のシナリオ を サポートします。

  • 1 つの要素を書き込む。 この場合、 WS_ELEMENT_DESCRIPTION の elementLocalName フィールドと elementNs フィールドは、書き込む要素のローカル名と名前空間に設定する必要があり、型と型の説明はシリアル化される値の型を表します。
  • 複数の要素を 1 つの値として書き込む。 この場合、 WS_ELEMENT_DESCRIPTION の elementLocalName フィールドと elementNs フィールドを NULL に設定し、 WS_STRUCT_TYPE と WS_STRUCT_DESCRIPTION を指定する必要があります。 シリアル化される構造体値の各フィールドは、エラーの詳細内で書き込む要素に対応している必要があります。 writeOption パラメーターは 、WS_WRITE_REQUIRED_VALUE または WS_WRITE_REQUIRED_POINTERである必要があります。

要件

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