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-terminated 文字列です。 NULL
[out] szDefaultObjectName
null-terminated 既定のオブジェクト名を受け取る呼び出し元によって割り当てられたバッファー。
PDH は常に既定のオブジェクト名の Processor を返します。
[in, out] pcchBufferSize
TCHARでの、szDefaultObjectName バッファーのサイズ。 入力時に 0 の場合、関数はPDH_MORE_DATAを返し、このパラメーターを必要なバッファー サイズに設定します。 バッファーが必要なサイズより大きい場合、関数はこのパラメーターを使用したバッファーの実際のサイズに設定します。 入力で指定したサイズが 0 より大きく、必要なサイズより小さい場合は、返されたサイズに依存してバッファーを再割り当てしないでください。
戻り値
関数が成功すると、ERROR_SUCCESSが返されます。
関数が失敗した場合、戻り値は システム エラー コード または PDH エラー コードです。 使用できる値を次に示します。
| リターン コード | 形容 |
|---|---|
|
szDefaultObjectName バッファーが小さすぎて、オブジェクト名を格納できません。 pcchBufferSize が入力時にゼロの場合、この戻り値が予期されます。 入力で指定したサイズが 0 より大きく、必要なサイズより小さい場合は、返されたサイズに依存してバッファーを再割り当てしないでください。 |
|
必須パラメーターが無効です。 たとえば、一部のリリースでは、入力で指定されたサイズが 0 より大きく、必要なサイズより小さい場合、このエラーが発生する可能性があります。 |
|
関数を完了するためにメモリを割り当てることができません。 |
|
指定されたコンピューターがオフラインであるか、使用できません。 |
備考
この関数を 2 回呼び出し、必要なバッファー サイズを取得する場合は 2 回 (
手記
pdh.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして PdhGetDefaultPerfObject を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows XP [デスクトップ アプリのみ] |
| サポートされる最小サーバー | Windows Server 2003 [デスクトップ アプリのみ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | pdh.h |
| ライブラリ | Pdh.lib |
| DLL | Pdh.dll |
関連項目
PdhGetDefaultPerfCounter の
PdhGetDefaultPerfObjectH を