ディスクの列挙

GUID_DEVINTERFACE_DISK は、ディスク デバイス インターフェイス クラスを識別します。 システム提供のディスク クラス ドライバーは、提供するディスクに対してこのクラスのインスタンスを登録します。 有効になっているこのインターフェイス クラスのインスタンスを列挙すると、使用するスタックに依存せずにディスク デバイスのパスを検出できます。従来のスタックと Native NVMe スタックのどちらも、このインターフェイス クラスを公開しているためです。

そのため、スタックに依存しないことが保証されていない GUID_DEVCLASS_DISKDRIVE などのデバイス セットアップ クラス GUID を基準にするのではなく、インターフェイス GUID を使用して列挙する必要があります。

インターフェイス GUID とデバイス クラス GUID

GUID_DEVINTERFACE_DISK と GUID_DEVCLASS_DISKDRIVE は異なる質問に答え、交換可能ではありません。

  • GUID_DEVINTERFACE_DISK は、個々のデバイス パスではなく、インターフェイス クラスを識別します。 有効なインスタンスを列挙すると、アプリケーションが CreateFileW に渡すことができるシンボリック リンク パスが返されます。 結果のハンドルは、要求されたアクセス権と適用可能なアクセス許可に従って、ターゲット ディスクでサポートされる操作に使用できます。 列挙パスは、ディスクを開く処理が成功するという保証ではありません。開く要求が完了する前に、デバイスが削除されたり、使用できなくなったりする可能性があります。
  • GUID_DEVCLASS_DISKDRIVE は、PnP/SetupAPI がデバイスのインストールと分類に使用するデバイス セットアップ クラスです。ドライバーのインストール、デバイス マネージャーでのグループ化、INF の照合などの保守作業に使用されます。 このセットアップ クラスに属するデバイス インスタンスは、開くことができるインターフェイスを公開するとは限りません。セットアップ クラスによる列挙では、そのデバイス インスタンスが現在公開している機能インターフェイス (存在する場合) については何も示しません。
  • 従来のディスク スタック (disk.sys/classpnp.sys) では GUID_DEVCLASS_DISKDRIVE セットアップ クラスが使用され、Native NVMe スタック (nvmedisk.sys) では独自の異なるセットアップ クラス {75416e63-5912-4dfa-ae8f-3efaccaffb14} が使用されます。 そのため、 GUID_DEVCLASS_DISKDRIVE のみを列挙すると、ネイティブ NVMe スタックによって管理されているすべてのディスクが見落とされます。 GUID_DEVINTERFACE_DISK は、両方のスタックが管理するディスクごとに同じインターフェイスを登録するため、このギャップはありません。

列挙スコープ

このサンプルでは、現在有効になっているディスク デバイス インターフェイスの 1 回限りの列挙を実行します。 ボリュームまたはドライブ文字は列挙されず、返されるリストは継続的に管理されるインベントリではありません。

CM_GET_DEVICE_INTERFACE_LIST_PRESENT は、現在存在し、有効になっているインターフェイスを選択します。 ディスク管理でディスクがオンラインかどうかは示されません。

デバイスの接続と取り外しを継続的に監視するアプリケーションでは、最初の列挙を実行する前に、CM_Register_Notification を使用してデバイス インターフェイスの通知を登録してください。 新たに接続されたインターフェイスは通知と最初の列挙結果の両方に現れる場合があるため、通知と初期リストを照合し、重複を処理してください。 完了したら、CM_Unregister_Notificationで通知の登録を解除してください。 デバイスの削除は、パスを開く処理や I/O の実行と競合する可能性があります。

サンプル コード: ディスクを列挙する

Note

再試行によって、サイズの照会から一覧の取得までの間に発生した変更に対処できますが、最終的に取得が成功することや、取得したデバイスをその後も継続して使用できることは保証されません。 このサンプルでは、CR_BUFFER_SMALL が返された場合に回数制限なく再試行するため、インターフェイスの接続が繰り返されると、理論上は再試行が無期限に続く可能性があります。 その他のエラーが発生した場合は、エラーを報告して列挙を終了します。

#define INITGUID
#include <windows.h>
#include <ntddstor.h>     // GUID_DEVINTERFACE_DISK
#include <cfgmgr32.h>
#include <stdio.h>
#include <stdlib.h>    // malloc, free
#include <wchar.h>     // wcslen

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

//
// Opens and closes the disk using its device interface path.
// Zero desired access is intentional: this sample does not read or write data.
// When extending it, request the access required by the intended operation:
// GENERIC_READ for reads, GENERIC_WRITE for writes, and the access required
// by the specific IOCTL. Applicable device permissions also apply.
//
static void
ProcessDisk(
    const wchar_t* DevicePath
    )
{
    HANDLE handle;

    handle = CreateFileW(
        DevicePath,
        0,  // No data read/write access requested.
        FILE_SHARE_READ | FILE_SHARE_WRITE,
        NULL,
        OPEN_EXISTING,
        0,
        NULL
        );

    if (handle == INVALID_HANDLE_VALUE)
    {
        wprintf(L"  open failed (%lu): %s\n", GetLastError(), DevicePath);
        return;
    }

    // TODO: perform a supported query whose access requirements are satisfied
    // by this handle. Adjust the CreateFileW access argument before adding
    // operations that require read or write access.

    CloseHandle(handle);
}

int
wmain(
    void
    )
{
    wchar_t* list;
    CONFIGRET cr;
    ULONG len;
    DWORD index;

    len = 0;

RetryEnumeration:
    //
    // Select currently enabled disk device interfaces.
    // This does not indicate the disk's online/offline state.
    //
    cr = CM_Get_Device_Interface_List_SizeW(
        &len,
        (LPGUID)&GUID_DEVINTERFACE_DISK,
        NULL,
        CM_GET_DEVICE_INTERFACE_LIST_PRESENT
        );

    if (cr != CR_SUCCESS || len == 0)
    {
        wprintf(L"CM_Get_Device_Interface_List_SizeW failed: 0x%lx\n", cr);
        return 1;
    }

    //
    // The result is a REG_MULTI_SZ style buffer: a contiguous run of
    // NUL-terminated device paths, terminated by an extra empty string.
    // 'len' is expressed in characters (including all NULs), so size the
    // allocation in wchar_t units, not bytes.
    //
    list = (wchar_t*)malloc((size_t)len * sizeof(wchar_t));

    if (list == NULL)
    {
        wprintf(L"Out of memory allocating %lu characters\n", len);
        return 1;
    }

    cr = CM_Get_Device_Interface_ListW(
        (LPGUID)&GUID_DEVINTERFACE_DISK,
        NULL,
        list,
        len,
        CM_GET_DEVICE_INTERFACE_LIST_PRESENT
        );

    if (cr == CR_BUFFER_SMALL)
    {
        // An interface may have arrived after the size query.
        free(list);
        goto RetryEnumeration;
    }

    if (cr != CR_SUCCESS)
    {
        wprintf(L"CM_Get_Device_Interface_ListW failed: 0x%lx\n", cr);
        free(list);
        return 1;
    }

    //
    // Walk the multi-string buffer, one NUL-terminated device path per
    // iteration, stopping at the empty string that terminates the list.
    // 'list' is guaranteed NUL-terminated by the API contract, so this
    // cannot run past the allocation.
    //
    index = 0;

    for (wchar_t* current = list; *current != L'\0'; current += wcslen(current) + 1)
    {
        wprintf(L"[%lu] %s\n", index, current);
        ProcessDisk(current);
        index++;
    }

    free(list);
    return 0;
}