WSManGetErrorMessage 関数 (wsman.h)

特定のエラー コードと言語コードに関連付けられているエラー メッセージを取得します。

構文

DWORD WSManGetErrorMessage(
  [in]           WSMAN_API_HANDLE apiHandle,
                 DWORD            flags,
  [in, optional] PCWSTR           languageCode,
                 DWORD            errorCode,
                 DWORD            messageLength,
  [out]          PWSTR            message,
  [out]          DWORD            *messageLengthUsed
);

パラメーター

[in] apiHandle

WSManInitialize 呼び出しによって返される API ハンドルを指定します。 このパラメーターを NULL にすることはできません。

flags

将来利用するために予約されています。 ゼロを指定してください。

[in, optional] languageCode

エラーのローカライズに使用する言語コード名を指定します。 言語コード名の詳細については、 のインターネット エンジニアリング タスク フォース http://www.ietf.org/rfc/rfc3066.txtの RFC 3066 仕様を参照してください。 言語コードが指定されていない場合は、スレッドのユーザー インターフェイス言語が使用されます。

errorCode

要求されたエラー メッセージのエラー コードを指定します。 このエラー コードには、WinRM、WinHTTP、またはその他の Windows オペレーティング システム機能からの 16 進数または 10 進数のエラー コードを指定できます。

messageLength

null 終端記号を含む、出力メッセージ バッファーに格納できる文字数を指定します。 このパラメーターが 0 の場合、 メッセージ パラメーターは NULL である必要があります。

[out] message

メッセージを格納する出力バッファーを指定します。 このバッファーは、クライアントによって割り当ておよび割り当て解除される必要があります。 バッファーは、メッセージと null 終端記号を格納するのに十分な大きさである必要があります。 このパラメーターが NULL の場合、 messageLength パラメーターは NULL である必要があります。

[out] messageLengthUsed

null 終端記号を含む、出力バッファーに書き込まれる実際の文字数を指定します。 このパラメーターを NULL にすることはできません。 messageLength パラメーターまたは message パラメーターが 0 の場合、関数は ERROR_INSUFFICIENT_BUFFERを返し、このパラメーターには、null ターミネータを含む、メッセージの格納に必要な文字数が設定されます。

戻り値

このメソッドは、成功すると 0 を返します。 それ以外の場合、このメソッドはエラー コードを返します。

要件

サポートされている最小のクライアント	Windows 7
サポートされている最小のサーバー	Windows Server 2008 R2
対象プラットフォーム	Windows
ヘッダー	wsman.h
Library	WsmSvc.lib
[DLL]	WsmSvc.dll
再頒布可能パッケージ	Windows Server 2008 SP2 と Windows Vista sp2 のWindows Management Framework