WsGetErrorString 関数 (webservices.h)

エラー オブジェクトからエラー文字列を取得します。

構文

HRESULT WsGetErrorString(
  [in]  WS_ERROR  *error,
  [in]  ULONG     index,
  [out] WS_STRING *string
);

パラメーター

[in] error

文字列を含む error オブジェクト。

[in] index

取得する文字列を識別する 0 から始まるインデックス。 最初のエラー文字列 (インデックス 0) は、エラー オブジェクトに最後に追加された文字列になります ( WsAddErrorString を使用)。 エラー オブジェクトにWS_ERROR_PROPERTY_ORIGINAL_ERROR_CODEが表示されると、対応するエラー テキストが最後のインデックスで使用できるようになります。

エラーの数は、 WS_ERROR_PROPERTY_STRING_COUNTを使用して取得できます。

[out] string

返される文字列。 この文字列は、 WsResetError または WsFreeError が呼び出されるまで有効です。

文字列が 0 で終わるわけではありません。

戻り値

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

注釈

文字列は、エラー オブジェクトの LANGID プロパティで指定された言語です。 これは、WS_ERROR_PROPERTY_LANGIDで WsGetErrorProperty を使用して取得できます。

要件