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

指定應該用來當地語系化錯誤的語言代碼名稱。 如需語言代碼名稱的詳細資訊，請參閱 Internet Engineering Task Force 的 RFC 3066 規格，網址為 http://www.ietf.org/rfc/rfc3066.txt 。 如果未指定語言代碼，則會使用執行緒的使用者介面語言。

errorCode

指定所要求錯誤訊息的錯誤碼。 此錯誤碼可以是 WinRM、WinHTTP 或其他 Windows 作業系統功能的十六進位或十進位錯誤碼。

messageLength

指定可以儲存在輸出訊息緩衝區中的字元數，包括 Null 結束字元。 如果此參數為零， 訊息 參數必須是 Null。

[out] message

指定要儲存訊息的輸出緩衝區。 此緩衝區必須由用戶端配置和解除配置。 緩衝區必須夠大，才能儲存訊息和 Null 結束字元。 如果此參數為 Null， messageLength 參數必須是 Null。

[out] messageLengthUsed

指定寫入輸出緩衝區的實際字元數，包括 Null 結束字元。 此參數不可為 Null。 如果 messageLength 或 訊息 參數為零，函式會 傳回ERROR_INSUFFICIENT_BUFFER ，而且此參數會設定為儲存訊息所需的字元數，包括 Null 結束字元。

傳回值

這個方法會在成功時傳回零。 否則，這個方法會傳回錯誤碼。

規格需求