PdhGetDefaultPerfObjectW 函式 (pdh.h)

  • 發行項

擷取預設物件的名稱。 此名稱可用來設定 [瀏覽計數器] 對話框中的初始物件選取範圍。

若要使用數據源的句柄，請使用 PdhGetDefaultPerfObjectH 函式。

語法

PDH_FUNCTION PdhGetDefaultPerfObjectW(
  [in]      LPCWSTR szDataSource,
  [in]      LPCWSTR szMachineName,
  [out]     LPWSTR  szDefaultObjectName,
  [in, out] LPDWORD pcchBufferSize
);

參數

[in] szDataSource

應該是 NULL。

如果您指定記錄檔， szDefaultObjectName 參數會是 Null 字串。

[in] szMachineName

以 Null 結尾的字串，指定用來驗證物件名稱的電腦名稱。 如果為 NULL，則會使用本機計算機來驗證名稱。

[out] szDefaultObjectName

呼叫端配置的緩衝區，接收 以 Null 終止的預設物件名稱。 如果pcchBufferSize參數為零，則設定為NULL。

請注意，PDH 一律會傳回預設物件名稱的 Processor。

[in, out] pcchBufferSize

SzDefaultObjectName 緩衝區的大小，以 TCHAR 為單位。 如果輸入為零，函式會傳回PDH_MORE_DATA，並將此參數設定為所需的緩衝區大小。 如果緩衝區大於所需的大小，函式會將此參數設定為所使用緩衝區的實際大小。 如果輸入上的指定大小大於零，但小於所需的大小，您就不應該依賴傳回的大小來重新配置緩衝區。

傳回值

如果函式成功，則會傳回ERROR_SUCCESS。

如果函式失敗，傳回值為 系統錯誤碼 或 PDH 錯誤碼。 以下是可能的值。

傳回碼 Description
PDH_MORE_DATA
 szDefaultObjectName 緩衝區太小而無法包含物件名稱。 如果 輸入上的pcchBufferSize 為零，則預期傳回值。 如果輸入上的指定大小大於零，但小於所需的大小，您就不應該依賴傳回的大小來重新配置緩衝區。
PDH_INVALID_ARGUMENT
 必要的參數無效。 例如，在某些版本中，如果輸入上的指定大小大於零，但小於所需的大小，您可能會收到此錯誤。
PDH_MEMORY_ALLOCATION_FAILURE
 無法配置記憶體以完成函式。
PDH_CSTATUS_NO_MACHINE
 指定的電腦離線或無法使用。

備註

您應該呼叫此函式兩次，第一次取得所需的緩衝區大小， (將 szDefaultObjectName 設定為 NULL ， 並將 pcchBufferSize 設定為 0) ，第二次取得數據。

注意

pdh.h 標頭會根據 UNICODE 預處理器常數的定義，將 PdhGetDefaultPerfObject 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows XP [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 [僅限桌面應用程式]
目標平台 Windows
標頭 pdh.h
程式庫 Pdh.lib
Dll Pdh.dll

另請參閱

PdhGetDefaultPerfCounter

PdhGetDefaultPerfObjectH