Função PdhAddCounterA (pdh.h)

Artigo
08/25/2023

Adiciona o contador especificado à consulta.

Sintaxe

PDH_FUNCTION PdhAddCounterA(
  [in]  PDH_HQUERY   hQuery,
  [in]  LPCSTR       szFullCounterPath,
  [in]  DWORD_PTR    dwUserData,
  [out] PDH_HCOUNTER *phCounter
);

Parâmetros

[in] hQuery

Manipule para a consulta à qual você deseja adicionar o contador. Esse identificador é retornado pela função PdhOpenQuery .

[in] szFullCounterPath

Cadeia de caracteres terminada em nulo que contém o caminho do contador. Para obter detalhes sobre o formato de um caminho de contador, consulte Especificando um caminho de contador. O comprimento máximo de um caminho de contador é PDH_MAX_COUNTER_PATH.

[in] dwUserData

Valor definido pelo usuário. Esse valor se torna parte das informações do contador. Para recuperar esse valor posteriormente, chame a função PdhGetCounterInfo e acesse o membro dwUserData da estrutura PDH_COUNTER_INFO .

[out] phCounter

Manipule para o contador que foi adicionado à consulta. Talvez seja necessário referenciar esse identificador em chamadas subsequentes.

Retornar valor

Retorne ERROR_SUCCESS se a função for bem-sucedida.

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_CSTATUS_BAD_COUNTERNAME	O caminho do contador não pôde ser analisado ou interpretado.
PDH_CSTATUS_NO_COUNTER	Não é possível localizar o contador especificado no computador ou no arquivo de log.
PDH_CSTATUS_NO_COUNTERNAME	O caminho do contador está vazio.
PDH_CSTATUS_NO_MACHINE	O caminho não continha um nome de computador e a função não pôde recuperar o nome do computador local.
PDH_CSTATUS_NO_OBJECT	Não é possível localizar o objeto especificado no computador ou no arquivo de log.
PDH_FUNCTION_NOT_FOUND	Não é possível determinar a função de cálculo a ser usada para esse contador.
PDH_INVALID_ARGUMENT	Um ou mais argumentos não são válidos.
PDH_INVALID_HANDLE	O identificador de consulta não é válido.
PDH_MEMORY_ALLOCATION_FAILURE	Não é possível alocar a memória necessária para concluir a função.

Comentários

Se o caminho do contador contiver um caractere curinga, todos os nomes de contador correspondentes ao caractere curinga serão adicionados à consulta.

Se uma instância de contador for especificada que ainda não existe, PdhAddCounter não relatará uma condição de erro. Em vez disso, retorna ERROR_SUCCESS. O motivo para esse comportamento é que não se sabe se uma instância de contador inexistente foi especificada ou se uma existirá, mas ainda não foi criada.

Para remover o contador da consulta, use a função PdhRemoveCounter .

Exemplos

Para obter um exemplo, consulte Navegando contadores de desempenho ou lendo dados de desempenho de um arquivo de log.

Observação

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	pdh.h
Biblioteca	Pdh.lib
DLL	Pdh.dll