PdhEnumLogSetNamesW 函式 (pdh.h)

  • 發行項

列舉 DSN 內的記錄集名稱。

語法

PDH_FUNCTION PdhEnumLogSetNamesW(
  [in]      LPCWSTR szDataSource,
  [out]     PZZWSTR mszDataSetNameList,
  [in, out] LPDWORD pcchBufferLength
);

參數

[in] szDataSource

指定 DSN 的 Null 終止字串。

[out] mszDataSetNameList

呼叫端配置的緩衝區，接收 Null終止的記錄集名稱清單。 清單會以 Null 終止符終止。 如果pcchBufferLength 參數為零，請將 設定為NULL。

[in, out] pcchBufferLength

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

傳回值

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

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

傳回碼 Description
PDH_MORE_DATA
 mszLogSetNameList 緩衝區的大小太小，無法包含所有數據。 如果 輸入上的pcchBufferLength 為零，就會預期這個傳回值。 如果輸入上的指定大小大於零，但小於所需的大小，您就不應該依賴傳回的大小來重新配置緩衝區。
PDH_INVALID_ARGUMENT
 參數無效。 例如，在某些版本中，如果輸入上的指定大小大於零，但小於所需的大小，您可能會收到此錯誤。

備註

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

注意

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

規格需求

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