Função PdhEnumObjectItemsHA (pdh.h)

Retorna o contador do objeto especificado e os nomes de instância que existem no computador especificado ou no arquivo de log especificado.

Essa função é idêntica à função PdhEnumObjectItems, exceto que dá suporte ao uso de identificadores para fontes de dados.

Sintaxe

PDH_FUNCTION PdhEnumObjectItemsHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szMachineName,
  [in]      LPCSTR   szObjectName,
  [out]     PZZSTR   mszCounterList,
  [in, out] LPDWORD  pcchCounterListLength,
  [out]     PZZSTR   mszInstanceList,
  [in, out] LPDWORD  pcchInstanceListLength,
  [in]      DWORD    dwDetailLevel,
  [in]      DWORD    dwFlags
);

Parâmetros

[in] hDataSource

Manipule para uma fonte de dados retornada pela função PdhBindInputDataSource .

[in] szMachineName

cadeia de caracteres nulaterminada que especifica o nome do computador que contém o contador e os nomes de instância que você deseja enumerar.

Inclua as barras principais no nome do computador, por exemplo, \computername.

Se o parâmetro szDataSource for NULL, você poderá definir szMachineName para NULL para especificar o computador local.

[in] szObjectName

cadeia de caracteres nulaterminada que especifica o nome do objeto cujo contador e nomes de instância você deseja enumerar.

[out] mszCounterList

Buffer alocado pelo chamador que recebe uma lista de nomes de contador nulosencerrados fornecidos pelo objeto especificado. A lista contém nomes de contador exclusivos. A lista é encerrada por dois caracteres NULL . Defina como NULL se o parâmetro pcchCounterListLength for zero.

[in, out] pcchCounterListLength

Tamanho do buffer de mszCounterList , em TCHARs . Se houver zero na entrada e no objeto, 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.

[out] mszInstanceList

Buffer alocado pelo chamador que recebe uma lista de nomes de instância nulosencerrados fornecidos pelo objeto especificado. A lista contém nomes de instância exclusivos. A lista é encerrada por dois caracteres NULL . Defina como NULL se o parâmetro pcchInstanceListLength for zero.

[in, out] pcchInstanceListLength

Tamanho do buffer mszInstanceList , em TCHARs. Se houver zero na entrada e no objeto, 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.

Se o objeto especificado não der suporte a instâncias variáveis, o valor retornado será zero. Se o objeto especificado der suporte a instâncias variáveis, mas não tiver nenhuma instância no momento, o valor retornado será 2, que é o tamanho de uma cadeia de caracteres de lista de MULTI_SZ vazia.

[in] dwDetailLevel

Nível de detalhes dos itens de desempenho a serem retornados. Todos os itens que são do nível de detalhes especificado ou menos serão retornados (os níveis são listados em ordem crescente). Esse parâmetro pode ser um dos valores a seguir.

Valor	Significado
PERF_DETAIL_NOVICE	Nível de detalhes do usuário novato.
PERF_DETAIL_ADVANCED	Nível de usuário avançado de detalhes.
PERF_DETAIL_EXPERT	Nível de usuário especialista em detalhes.
PERF_DETAIL_WIZARD	Nível de detalhes do designer do sistema.

[in] dwFlags

Esse parâmetro deve ser zero.

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	Um dos buffers é muito pequeno para conter a lista de nomes. Esse valor retornado será esperado se pcchCounterListLength ou pcchInstanceListLength 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.
PDH_MEMORY_ALLOCATION_FAILURE	Não é possível alocar memória para dar suporte a essa função.
PDH_CSTATUS_NO_MACHINE	O computador especificado está offline ou indisponível.
PDH_CSTATUS_NO_OBJECT	O objeto especificado não pôde ser encontrado no computador especificado ou no arquivo de log especificado.

Observações

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

Chamadas consecutivas para essa função retornarão listas idênticas de contadores e instâncias, pois PdhEnumObjectItemsH sempre consultará a lista de objetos de desempenho definidos pela última chamada para PdhEnumObjectsH ou PdhEnumObjectItemsH. Para atualizar a lista de objetos de desempenho, chame PdhEnumObjectsH com um valor de sinalizador bRefresh de TRUE antes de chamar PdhEnumObjectItemsH novamente.

A ordem dos nomes da instância e do contador é indeterminada.

Nota

O cabeçalho pdh.h define PdhEnumObjectItemsH 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

Consulte também

PdhBindInputDataSource

PdhEnumObjectsH