PdhGetDefaultPerfObjectA 関数 (pdh.h)
既定のオブジェクトの名前を取得します。 この名前は、[カウンターの参照] ダイアログ ボックスで最初のオブジェクトの選択を設定するために使用できます。
データ ソースにハンドルを使用するには、 PdhGetDefaultPerfObjectH 関数を 使用します。
構文
PDH_FUNCTION PdhGetDefaultPerfObjectA(
[in] LPCSTR szDataSource,
[in] LPCSTR szMachineName,
[out] LPSTR szDefaultObjectName,
[in, out] LPDWORD pcchBufferSize
);
パラメーター
[in] szDataSource
NULL にする必要があります。
ログ ファイルを指定した場合、 szDefaultObjectName パラメーターは null 文字列になります。
[in] szMachineName
オブジェクト名の確認に使用されるコンピューターの名前を指定する Null で終わる文字列。 NULL の場合、ローカル コンピューターを使用して名前が確認されます。
[out] szDefaultObjectName
null で終わる既定のオブジェクト名を受け取る呼び出し元によって割り当てられたバッファー。 pcchBufferSize パラメーターが 0 の場合は NULL に設定します。
PDH は常に既定のオブジェクト名の Processor を返します。
[in, out] pcchBufferSize
TCHAR の szDefaultObjectName バッファーのサイズ。 入力時に 0 の場合、関数は PDH_MORE_DATAを返し、このパラメーターを必要なバッファー サイズに設定します。 バッファーが必要なサイズより大きい場合、関数は、このパラメーターを使用したバッファーの実際のサイズに設定します。 入力時に指定したサイズが 0 より大きく、必要なサイズより小さい場合は、返されたサイズに依存してバッファーを再割り当てしないでください。
戻り値
関数が成功すると、ERROR_SUCCESSが返されます。
関数が失敗した場合、戻り値は システム エラー コード または PDH エラー コードです。 使用できる値を次に示します。
| リターン コード | 説明 |
|---|---|
|
szDefaultObjectName バッファーが小さすぎてオブジェクト名を含められません。 この戻り値は、 入力時に pcchBufferSize がゼロの場合に想定されます。 入力時に指定したサイズが 0 より大きく、必要なサイズより小さい場合は、返されたサイズに依存してバッファーを再割り当てしないでください。 |
|
必須パラメーターが無効です。 たとえば、一部のリリースでは、入力の指定されたサイズが 0 より大きく、必要なサイズより小さい場合に、このエラーが発生する可能性があります。 |
|
関数を完了するためにメモリを割り当てることができません。 |
|
指定したコンピューターがオフラインであるか、使用できません。 |
注釈
この関数は 2 回呼び出す必要があります。最初に必要なバッファー サイズを取得し ( szDefaultObjectName を NULL に、 pcchBufferSize を 0 に設定)、2 回目にデータを取得します。
注意
pdh.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして PdhGetDefaultPerfObject を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | pdh.h |
| Library | Pdh.lib |
| [DLL] | Pdh.dll |