PdhExpandCounterPathA 関数 (pdh.h)

カウンター パス内のワイルドカード文字列に一致するカウンターとカウンターのインスタンスについて、指定されたコンピューター (または指定されていない場合はローカル コンピューター) を調べます。

構文

PDH_FUNCTION PdhExpandCounterPathA(
  [in]      LPCSTR  szWildCardPath,
  [out]     PZZSTR  mszExpandedPathList,
  [in, out] LPDWORD pcchPathListLength
);

パラメーター

[in] szWildCardPath

展開するカウンター パスを含む Null で終わる文字列。 関数は、パスで指定されたコンピューターを検索して一致を検索します。 パスでコンピューターが指定されていない場合、関数はローカル コンピューターを検索します。 カウンター パスの最大長はPDH_MAX_COUNTER_PATH。

[out] mszExpandedPathList

szWildCardPath のワイルドカード指定に一致する展開されたカウンター パスの一覧を受け取る呼び出し元割り当てバッファー。 この一覧の各カウンター パスは null 文字で終了します。 リストは 2 つの NULL 文字で終了します。 pcchPathListLength が 0 の場合は NULL に設定します。

[in, out] pcchPathListLength

TCHAR の mszExpandedPathList バッファーのサイズ。 入力時に 0 の場合、関数は PDH_MORE_DATAを返し、このパラメーターを必要なバッファー サイズに設定します。 バッファーが必要なサイズより大きい場合、関数は、このパラメーターを使用したバッファーの実際のサイズに設定します。 入力時に指定したサイズが 0 より大きく、必要なサイズより小さい場合は、返されたサイズに依存してバッファーを再割り当てしないでください。

戻り値

関数が成功すると、ERROR_SUCCESSが返されます。

関数が失敗した場合、戻り値は システム エラー コード または PDH エラー コードです。

注釈

この関数は 2 回呼び出す必要があります。最初に必要なバッファー サイズを取得し ( mszExpandedPathList を NULL に設定し、 pcchPathListLength を 0 に設定)、2 回目にデータを取得します。

一般的なカウンター パスの形式は次のとおりです。

\computer\object(parent/instance#index)\counter

カウンター パスの親、インスタンス、インデックス、およびカウンター コンポーネントには、有効な名前またはワイルドカード文字を含めることがあります。 コンピューター、親、インスタンス、およびインデックスのコンポーネントでは、すべてのカウンタは必要ありません。

使用する必要があるカウンター パスは、カウンター自体によって決まります。 たとえば、LogicalDisk オブジェクトにはインスタンス インデックスがあるため、#index またはワイルドカードを指定する必要があります。 したがって、次の形式を使用できます。

\LogicalDisk(/#*)*

これに対し、Process オブジェクトにはインスタンス インデックスは必要ありません。 したがって、次の形式を使用できます。

\Process(*)\ID Process

使用できる形式の一覧を次に示します。

• \\computer\object(parent/instance#index)\counter
• \\computer\object(parent/instance)\counter
• \\computer\object(instance#index)\counter
• \\computer\object(instance)\counter
• \\computer\object\counter
• \object(parent/instance#index)\counter
• \object(parent/instance)\counter
• \object(instance#index)\counter
• \object(instance)\counter
• \object\counter

インスタンス名にワイルドカード文字を指定すると場合、は、指定したインデックスに対応するすべてのインスタンス名にワイルドカード文字が一致する場合に指定されたオブジェクトと親オブジェクトのすべてのインスタンスが返されます。

カウンター名にワイルドカード文字を指定すると、指定したオブジェクトのすべてのカウンターが返されます。

部分的なカウンター パス文字列の一致 ("pro*"など) はサポートされていません。

例

次の例では、この関数の方法を示します。

#include <windows.h>
#include <stdio.h>
#include <stdlib.h>
#include <pdh.h>
#include <pdhmsg.h>

#pragma comment(lib, "pdh.lib")

CONST PWSTR WILDCARD_PATH = L"\\Processor(*)\\*";

void wmain(void)
{
    PDH_STATUS Status;
    PWSTR EndOfPaths;
    PWSTR Paths = NULL;
    DWORD BufferSize = 0;

    Status = PdhExpandCounterPath(WILDCARD_PATH, Paths, &BufferSize);

    while (Status == PDH_MORE_DATA) 
    {
        Paths = (PWSTR)malloc(BufferSize * sizeof(WCHAR));
        Status = PdhExpandCounterPath(WILDCARD_PATH, Paths, &BufferSize);
    }

    if (Status != ERROR_SUCCESS) 
    {
        wprintf(L"\nPdhExpandCounterPath failed with status 0x%x", Status);
        goto Cleanup;
    }

    if (Paths == NULL) 
    {
        wprintf(L"\nThe counter path %s cannot be expanded.", WILDCARD_PATH);
        goto Cleanup;
    }

    EndOfPaths = Paths + BufferSize;

    // On Vista and later operating systems, the buffer is terminated with two 
    // null-terminator characters; however, on earlier systems, the buffer is
    // not terminated with two null-terminator characters. This covers both cases.
    for (PWSTR p = Paths; ((p != EndOfPaths) && (*p != L'\0')); p += wcslen(p) + 1) 
    {
        wprintf(L"\n%s", p);
    }

Cleanup:
    if (Paths) 
    {
        free(Paths);
    }
}

要件

こちらもご覧ください

PdhExpandWildCardPath

PdhMakeCounterPath