Funzione PdhGetCounterInfoA (pdh.h)

Articolo
11/20/2024

Recupera informazioni su un contatore, ad esempio dimensioni dei dati, tipo di contatore, percorso e valori di dati forniti dall'utente.

Sintassi

PDH_FUNCTION PdhGetCounterInfoA(
  [in]      PDH_HCOUNTER        hCounter,
  [in]      BOOLEAN             bRetrieveExplainText,
  [in, out] LPDWORD             pdwBufferSize,
  [out]     PPDH_COUNTER_INFO_A lpBuffer
);

Parametri

[in] hCounter

Handle del contatore da cui si desidera recuperare le informazioni. La funzione pdhAddCounter restituisce questo handle.

[in] bRetrieveExplainText

Determina se viene recuperato il testo di spiegazione. Se si imposta questo parametro su TRUE, viene recuperato il testo di spiegazione per il contatore. Se si imposta questo parametro su FALSE, il campo nel buffer restituito viene NULL.

[in, out] pdwBufferSize

Dimensioni del buffer lpBuffer in byte. Se zero in ingresso, la funzione restituisce PDH_MORE_DATA e imposta questo parametro sulla dimensione del buffer richiesta. Se il buffer è maggiore delle dimensioni necessarie, la funzione imposta questo parametro sulle dimensioni effettive del buffer utilizzato. Se la dimensione specificata per l'input è maggiore di zero ma minore della dimensione richiesta, non è consigliabile basarsi sulle dimensioni restituite per riallocare il buffer.

[out] lpBuffer

Buffer allocato dal chiamante che riceve una struttura PDH_COUNTER_INFO. La struttura è a lunghezza variabile, perché i dati stringa vengono accodati alla fine della parte di formato fisso della struttura. Questa operazione viene eseguita in modo che tutti i dati vengano restituiti in un singolo buffer allocato dal chiamante. Impostare su NULL se pdwBufferSize è zero.

Valore restituito

Se la funzione ha esito positivo, restituisce ERROR_SUCCESS.

Se la funzione ha esito negativo, il valore restituito è un codice di errore di sistema o un codice di errore PDH . Di seguito sono riportati i valori possibili.

Codice restituito	Descrizione
PDH_INVALID_ARGUMENT	Un parametro non è valido o non è formattato correttamente. Ad esempio, in alcune versioni è possibile ricevere questo errore se la dimensione specificata per l'input è maggiore di zero, ma minore della dimensione richiesta.
PDH_INVALID_HANDLE	L'handle del contatore non è valido.
PDH_MORE_DATA	Il buffer lpBuffer è troppo piccolo per contenere le informazioni sul contatore. Questo valore restituito è previsto se pdwBufferSize è zero all'input. Se la dimensione specificata per l'input è maggiore di zero ma minore della dimensione richiesta, non è consigliabile basarsi sulle dimensioni restituite per riallocare il buffer.

Osservazioni

È necessario chiamare questa funzione due volte, la prima volta per ottenere le dimensioni del buffer necessarie (impostare lpBuffer su NULL e pdwBufferSize su 0) e la seconda volta per ottenere i dati.

Nota

L'intestazione pdh.h definisce PdhGetCounterInfo come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
client minimo supportato	Windows XP [solo app desktop]
server minimo supportato	Windows Server 2003 [solo app desktop]
piattaforma di destinazione	Finestre
intestazione	pdh.h
libreria	Pdh.lib
dll	Pdh.dll

Vedere anche

PDH_COUNTER_INFO

Condividi tramite