Função PdhParseCounterPathA (pdh.h)

Artigo
11/20/2024

Analisa os elementos do caminho do contador e armazena os resultados na estrutura de PDH_COUNTER_PATH_ELEMENTS.

Sintaxe

PDH_FUNCTION PdhParseCounterPathA(
  [in]      LPCSTR                       szFullPathBuffer,
  [out]     PPDH_COUNTER_PATH_ELEMENTS_A pCounterPathElements,
  [in, out] LPDWORD                      pdwBufferSize,
            DWORD                        dwFlags
);

Parâmetros

[in] szFullPathBuffer

cadeia de caracteres terminada pornulo que contém o caminho do contador a ser analisado. O comprimento máximo de um caminho de contador é PDH_MAX_COUNTER_PATH.

[out] pCounterPathElements

Buffer alocado pelo chamador que recebe uma estrutura de PDH_COUNTER_PATH_ELEMENTS. A estrutura contém ponteiros para os elementos de cadeia de caracteres individuais do caminho referenciado pelo parâmetro szFullPathBuffer. A função acrescenta as cadeias de caracteres ao final da estrutura PDH_COUNTER_PATH_ELEMENTS. O buffer alocado deve ser grande o suficiente para a estrutura e as cadeias de caracteres. Defina como NULL se pdwBufferSize for zero.

[in, out] pdwBufferSize

Tamanho do buffer pCounterPathElements, em bytes. 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.

dwFlags

Reservado. 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_INVALID_ARGUMENT	Um parâmetro não é válido.
PDH_MORE_DATA	O pCounterPathElements buffer é muito pequeno para conter os elementos de caminho. Esse valor retornado será esperado se pdwBufferSize 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_PATH	O caminho não está formatado corretamente e não pode ser analisado. 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 concluir a função.

Observações

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

Nota

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

PDH_COUNTER_PATH_ELEMENTS

PdhMakeCounterPath

Compartilhar via