Compartilhar via


Função WSManGetErrorMessage (wsman.h)

Recupera as mensagens de erro associadas a um erro específico e códigos de idioma.

Sintaxe

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

Parâmetros

[in] apiHandle

Especifica o identificador de API retornado por uma chamada WSManInitialize . Esse parâmetro não pode ser NULL.

flags

Reservado para uso futuro. Deve ser zero.

[in, optional] languageCode

Especifica o nome do código do idioma que deve ser usado para localizar o erro. Para obter mais informações sobre os nomes de código de linguagem, consulte a especificação RFC 3066 da Força-Tarefa de Engenharia da Internet em http://www.ietf.org/rfc/rfc3066.txt. Se um código de linguagem não for especificado, a linguagem de interface do usuário do thread será usada.

errorCode

Especifica o código de erro para a mensagem de erro solicitada. Esse código de erro pode ser um código de erro hexadecimal ou decimal de um WinRM, WinHTTP ou outro recurso do sistema operacional Windows.

messageLength

Especifica o número de caracteres que podem ser armazenados no buffer de mensagem de saída, incluindo o terminador nulo . Se esse parâmetro for zero, o parâmetro de mensagem deverá ser NULL.

[out] message

Especifica o buffer de saída no qual armazenar a mensagem. Esse buffer deve ser alocado e desalocado pelo cliente. O buffer deve ser grande o suficiente para armazenar a mensagem e o terminador nulo . Se esse parâmetro for NULL, o parâmetro messageLength deverá ser NULL.

[out] messageLengthUsed

Especifica o número real de caracteres gravados no buffer de saída, incluindo o terminador nulo . Esse parâmetro não pode ser NULL. Se os parâmetros messageLength ou message forem zero, a função retornará ERROR_INSUFFICIENT_BUFFER e esse parâmetro será definido como o número de caracteres necessários para armazenar a mensagem, incluindo o terminador nulo .

Valor retornado

Esse método retorna zero em caso de êxito. Caso contrário, esse método retornará um código de erro.

Requisitos

   
Cliente mínimo com suporte Windows 7
Servidor mínimo com suporte Windows Server 2008 R2
Plataforma de Destino Windows
Cabeçalho wsman.h
Biblioteca WsmSvc.lib
DLL WsmSvc.dll
Redistribuível Windows Management Framework no Windows Server 2008 com SP2 e Windows Vista com SP2