Função PdhAddEnglishCounterA (pdh.h)

Artigo
11/20/2024

Adiciona o contador neutro de idioma especificado à consulta.

Sintaxe

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

Parâmetros

[in] hQuery

Manipule 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 dwQueryUserData membro 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.

Valor de retorno

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.

Observações

Essa função fornece uma maneira neutra em linguagem para adicionar contadores de desempenho à consulta. Por outro lado, o caminho do contador especificado na função PdhAddCounter deve ser localizado.

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

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

Observação Se o caminho do contador contiver um caractere curinga, as partes não curinga do caminho serão localizadas, mas curingas não serão expandidos antes de adicionar o caminho do contador localizado à consulta. Nesse caso, você precisará usar o procedimento a seguir para adicionar todos os nomes de contador correspondentes à consulta.

Fazer uma consulta
Use PdhAddEnglishCounter com a cadeia de caracteres que contém curingas
Use PdhGetCounterInfo no identificador de contador retornado por PdhAddEnglishCounter para obter um caminho completo localizado (szFullPath.) Essa cadeia de caracteres ainda contém caracteres curinga, mas as partes não curinga agora estão localizadas.
Use PdhExpandWildCardPath para expandir os curingas.
Usar PdhAddCounter em cada um dos caminhos resultantes

Nota

O cabeçalho pdh.h define PdhAddEnglishCounter 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 Vista [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2008 [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

PdhAddCounter

PdhBrowseCounters

PdhMakeCounterPath

PdhOpenQuery

PdhRemoveCounter

Compartilhar via