Funzione PdhGetDefaultPerfObjectA (pdh.h)

Articolo
11/20/2024

Recupera il nome dell'oggetto predefinito. Questo nome può essere utilizzato per impostare la selezione iniziale dell'oggetto nella finestra di dialogo Sfoglia contatore.

Per usare handle per le origini dati, usare la funzione pdhGetDefaultPerfObjectH.

Sintassi

PDH_FUNCTION PdhGetDefaultPerfObjectA(
  [in]      LPCSTR  szDataSource,
  [in]      LPCSTR  szMachineName,
  [out]     LPSTR   szDefaultObjectName,
  [in, out] LPDWORD pcchBufferSize
);

Parametri

[in] szDataSource

Deve essere null.

Se si specifica un file di log, il parametro szDefaultObjectName sarà una stringa null .

[in] szMachineName

Nullstringa con terminazione che specifica il nome del computer utilizzato per verificare il nome dell'oggetto. Se NULL, il computer locale viene usato per verificare il nome.

[out] szDefaultObjectName

Buffer allocato dal chiamante che riceve il null-terminato nome dell'oggetto predefinito. Impostare su NULL se il parametro pcchBufferSize è zero.

Si noti che PDH restituisce sempre Processore per il nome dell'oggetto predefinito.

[in, out] pcchBufferSize

Dimensioni del buffer di szDefaultObjectName, in TCHARs. 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.

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_MORE_DATA	Il buffer szDefaultObjectName è troppo piccolo per contenere il nome dell'oggetto. Questo valore restituito è previsto se pcchBufferSize è 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.
PDH_INVALID_ARGUMENT	Un parametro obbligatorio non è valido. 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_MEMORY_ALLOCATION_FAILURE	Impossibile allocare memoria per completare la funzione.
PDH_CSTATUS_NO_MACHINE	Il computer specificato è offline o non disponibile.

Osservazioni

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

Nota

L'intestazione pdh.h definisce PdhGetDefaultPerfObject 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

PdhGetDefaultPerfCounter

PdhGetDefaultPerfObjectH

Condividi tramite