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 工程任务组中的 http://www.ietf.org/rfc/rfc3066.txtRFC 3066 规范。 如果未指定语言代码，则使用线程的用户界面语言。

errorCode

指定请求的错误消息的错误代码。 此错误代码可以是来自 WinRM、WinHTTP 或其他 Windows 操作系统功能的十六进制或十进制错误代码。

messageLength

指定可在输出消息缓冲区中存储的字符数，包括 null 终止符。 如果此参数为零，则 消息 参数必须为 NULL。

[out] message

指定要存储消息的输出缓冲区。 此缓冲区必须由客户端分配和解除分配。 缓冲区必须足够大才能存储消息和 null 终止符。 如果此参数为 NULL，则 messageLength 参数必须为 NULL。

[out] messageLengthUsed

指定写入到输出缓冲区的实际字符数，包括 null 终止符。 此参数不能为 NULL。 如果 messageLength 或 message 参数为零，则该函数将返回 ERROR_INSUFFICIENT_BUFFER ，并将此参数设置为存储消息所需的字符数，包括 null 终止符。

返回值

此方法在成功时返回零。 否则，此方法将返回错误代码。

要求