Função PdhEnumLogSetNamesA (pdh.h)

Artigo
11/20/2024

Enumera os nomes dos conjuntos de logs dentro do DSN.

Sintaxe

PDH_FUNCTION PdhEnumLogSetNamesA(
  [in]      LPCSTR  szDataSource,
  [out]     PZZSTR  mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

Parâmetros

[in] szDataSource

cadeia de caracteres terminada pornulo que especifica o DSN.

[out] mszDataSetNameList

Buffer alocado pelo chamador que recebe a lista de nomes nulos de conjunto de logsencerrados. A lista é encerrada com um caractere nulo-terminator. Defina como NULL se o parâmetro pcchBufferLength for zero.

[in, out] pcchBufferLength

Tamanho do buffer mszLogSetNameList de , em TCHARs. Se zero na entrada, a função retornará PDH_MORE_DATA e definirá esse parâmetro como o tamanho do buffer necessário. Se o buffer for maior que o tamanho necessário, a função definirá esse parâmetro como o tamanho real do buffer usado. Se o tamanho especificado na entrada for maior que zero, mas menor que o tamanho necessário, você não deverá contar com o tamanho retornado para realocar o buffer.

Valor de retorno

Se a função for bem-sucedida, ela retornará ERROR_SUCCESS.

Se a função falhar, o valor retornado será um código de erro do sistema ou um código de erro PDH . Veja a seguir os valores possíveis.

Código de retorno	Descrição
PDH_MORE_DATA	O tamanho do buffer mszLogSetNameList é muito pequeno para conter todos os dados. Esse valor retornado será esperado se pcchBufferLength for zero na entrada. Se o tamanho especificado na entrada for maior que zero, mas menor que o tamanho necessário, você não deverá contar com o tamanho retornado para realocar o buffer.
PDH_INVALID_ARGUMENT	Um parâmetro não é válido. Por exemplo, em algumas versões, você poderá receber esse erro se o tamanho especificado na entrada for maior que zero, mas menor que o tamanho necessário.

Observações

Você deve chamar essa função duas vezes, a primeira vez para obter o tamanho do buffer necessário (definir mszLogSetNameList para NULL e pcchBufferLength para 0) e a segunda vez para obter os dados.

Nota

O cabeçalho pdh.h define PdhEnumLogSetNames como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	pdh.h
biblioteca	Pdh.lib
de DLL	Pdh.dll

Compartilhar via