SetupApi から CfgMgr32 へのコードの移植
このトピックでは、代わりにSetupapi.dll機能を使用してCfgmgr32.dllを使用するコードを移植する方法を示すコード例を示します。 コードを移植すると、SetupApi をサポートしていないユニバーサル Windows プラットフォーム (UWP) でコードを実行できます。 CfgMgr32 のサブセットは、UWP、特に API セット (Windows 8 以降) または api-ms-win-devices-config-l1-1-0.dll API セット (Windows 8.1 以降) を介してapi-ms-win-devices-config-l1-1-1.dll公開される機能でサポートされています。 Windows 10 以降では、次にリンクするだけです onecore.lib。
上記の API セットの関数の一覧については、Windows API セットまたは Onecore.lib: api-ms-win-devices-config-l1-1-1.dllの API を参照してください。
次のセクションでは、アプリケーションが通常使用するコード例を示します。
- 現在のデバイスの一覧を取得し、各デバイスのプロパティを取得する
- インターフェイスの一覧を取得し、各インターフェイスを公開しているデバイスを取得し、デバイスからプロパティを取得します
- 特定のデバイスからプロパティを取得する
- デバイスを無効にする
- デバイスを有効にする
- デバイスの再起動
現在のデバイスの一覧を取得し、各デバイスのプロパティを取得する
この例では、SetupDiGetClassDevs を使用して現在のすべてのデバイスの一覧を取得し、それらを反復処理して各デバイスのデバイスの説明を取得します。
VOID
GetDevicePropertiesSetupapi(
VOID
)
{
HDEVINFO DeviceInfoSet = INVALID_HANDLE_VALUE;
SP_DEVINFO_DATA DeviceInfoData;
DWORD Index;
WCHAR DeviceDesc[2048];
DEVPROPTYPE PropertyType;
DeviceInfoSet = SetupDiGetClassDevs(NULL,
NULL,
NULL,
DIGCF_ALLCLASSES | DIGCF_PRESENT);
if (DeviceInfoSet == INVALID_HANDLE_VALUE)
{
goto Exit;
}
ZeroMemory(&DeviceInfoData, sizeof(DeviceInfoData));
DeviceInfoData.cbSize = sizeof(DeviceInfoData);
for (Index = 0;
SetupDiEnumDeviceInfo(DeviceInfoSet,
Index,
&DeviceInfoData);
Index++)
{
// Query a property on the device. For example, the device description.
if (!SetupDiGetDeviceProperty(DeviceInfoSet,
&DeviceInfoData,
&DEVPKEY_Device_DeviceDesc,
&PropertyType,
(PBYTE)DeviceDesc,
sizeof(DeviceDesc),
NULL,
0))
{
// The error can be retrieved with GetLastError();
continue;
}
if (PropertyType != DEVPROP_TYPE_STRING)
{
continue;
}
}
if (GetLastError() != ERROR_NO_MORE_ITEMS)
{
goto Exit;
}
Exit:
if (DeviceInfoSet != INVALID_HANDLE_VALUE)
{
SetupDiDestroyDeviceInfoList(DeviceInfoSet);
}
return;
}
この例では、CM_Get_Device_ID_List を使用して現在のすべてのデバイスの一覧を取得し、それらを反復処理して各デバイスのデバイスの説明を取得します。
VOID
GetDevicePropertiesCfgmgr32(
VOID
)
{
CONFIGRET cr = CR_SUCCESS;
PWSTR DeviceList = NULL;
ULONG DeviceListLength = 0;
PWSTR CurrentDevice;
DEVINST Devinst;
WCHAR DeviceDesc[2048];
DEVPROPTYPE PropertyType;
ULONG PropertySize;
DWORD Index = 0;
cr = CM_Get_Device_ID_List_Size(&DeviceListLength,
NULL,
CM_GETIDLIST_FILTER_PRESENT);
if (cr != CR_SUCCESS)
{
goto Exit;
}
DeviceList = (PWSTR)HeapAlloc(GetProcessHeap(),
HEAP_ZERO_MEMORY,
DeviceListLength * sizeof(WCHAR));
if (DeviceList == NULL) {
goto Exit;
}
cr = CM_Get_Device_ID_List(NULL,
DeviceList,
DeviceListLength,
CM_GETIDLIST_FILTER_PRESENT);
if (cr != CR_SUCCESS)
{
goto Exit;
}
for (CurrentDevice = DeviceList;
*CurrentDevice;
CurrentDevice += wcslen(CurrentDevice) + 1)
{
// If the list of devices also includes non-present devices,
// CM_LOCATE_DEVNODE_PHANTOM should be used in place of
// CM_LOCATE_DEVNODE_NORMAL.
cr = CM_Locate_DevNode(&Devinst,
CurrentDevice,
CM_LOCATE_DEVNODE_NORMAL);
if (cr != CR_SUCCESS)
{
goto Exit;
}
// Query a property on the device. For example, the device description.
PropertySize = sizeof(DeviceDesc);
cr = CM_Get_DevNode_Property(Devinst,
&DEVPKEY_Device_DeviceDesc,
&PropertyType,
(PBYTE)DeviceDesc,
&PropertySize,
0);
if (cr != CR_SUCCESS)
{
Index++;
continue;
}
if (PropertyType != DEVPROP_TYPE_STRING)
{
Index++;
continue;
}
Index++;
}
Exit:
if (DeviceList != NULL)
{
HeapFree(GetProcessHeap(),
0,
DeviceList);
}
return;
}
インターフェイスの一覧を取得し、各インターフェイスを公開しているデバイスを取得し、デバイスからプロパティを取得します
この例では、SetupDiGetClassDevs を使用してGUID_DEVINTERFACE_VOLUME クラス内のすべてのインターフェイスの一覧を取得します。 インターフェイスごとに、インターフェイスを公開しているデバイスを取得し、そのデバイスのプロパティを取得します。
VOID
GetInterfacesAndDevicePropertySetupapi(
VOID
)
{
HDEVINFO DeviceInfoSet = INVALID_HANDLE_VALUE;
SP_DEVICE_INTERFACE_DATA DeviceInterfaceData;
SP_DEVINFO_DATA DeviceInfoData;
DWORD Index;
WCHAR DeviceDesc[2048];
DEVPROPTYPE PropertyType;
DeviceInfoSet = SetupDiGetClassDevs(&GUID_DEVINTERFACE_VOLUME,
NULL,
NULL,
DIGCF_DEVICEINTERFACE);
if (DeviceInfoSet == INVALID_HANDLE_VALUE)
{
goto Exit;
}
ZeroMemory(&DeviceInterfaceData, sizeof(DeviceInterfaceData));
DeviceInterfaceData.cbSize = sizeof(DeviceInterfaceData);
for (Index = 0;
SetupDiEnumDeviceInterfaces(DeviceInfoSet,
NULL,
&GUID_DEVINTERFACE_VOLUME,
Index,
&DeviceInterfaceData);
Index++)
{
ZeroMemory(&DeviceInfoData, sizeof(DeviceInfoData));
DeviceInfoData.cbSize = sizeof(DeviceInfoData);
if ((!SetupDiGetDeviceInterfaceDetail(DeviceInfoSet,
&DeviceInterfaceData,
NULL,
0,
NULL,
&DeviceInfoData)) &&
(GetLastError() != ERROR_INSUFFICIENT_BUFFER))
{
// The error can be retrieved with GetLastError();
goto Exit;
}
// Query a property on the device. For example, the device description.
if (!SetupDiGetDeviceProperty(DeviceInfoSet,
&DeviceInfoData,
&DEVPKEY_Device_DeviceDesc,
&PropertyType,
(PBYTE)DeviceDesc,
sizeof(DeviceDesc),
NULL,
0))
{
// The error can be retrieved with GetLastError();
goto Exit;
}
if (PropertyType != DEVPROP_TYPE_STRING)
{
goto Exit;
}
}
if (GetLastError() != ERROR_NO_MORE_ITEMS)
{
goto Exit;
}
Exit:
if (DeviceInfoSet != INVALID_HANDLE_VALUE)
{
SetupDiDestroyDeviceInfoList(DeviceInfoSet);
}
return;
}
この例では、CM_Get_Device_Interface_Listを使用してクラス GUID_DEVINTERFACE_VOLUME内のすべてのインターフェイスの一覧を取得します。 インターフェイスごとに、インターフェイスを公開しているデバイスを取得し、そのデバイスのプロパティを取得します。
VOID
GetInterfacesAndDevicePropertyCfgmgr32(
VOID
)
{
CONFIGRET cr = CR_SUCCESS;
PWSTR DeviceInterfaceList = NULL;
ULONG DeviceInterfaceListLength = 0;
PWSTR CurrentInterface;
WCHAR CurrentDevice[MAX_DEVICE_ID_LEN];
DEVINST Devinst;
WCHAR DeviceDesc[2048];
DEVPROPTYPE PropertyType;
ULONG PropertySize;
DWORD Index = 0;
do {
cr = CM_Get_Device_Interface_List_Size(&DeviceInterfaceListLength,
(LPGUID)&GUID_DEVINTERFACE_VOLUME,
NULL,
CM_GET_DEVICE_INTERFACE_LIST_ALL_DEVICES);
if (cr != CR_SUCCESS)
{
break;
}
if (DeviceInterfaceList != NULL) {
HeapFree(GetProcessHeap(),
0,
DeviceInterfaceList);
}
DeviceInterfaceList = (PWSTR)HeapAlloc(GetProcessHeap(),
HEAP_ZERO_MEMORY,
DeviceInterfaceListLength * sizeof(WCHAR));
if (DeviceInterfaceList == NULL)
{
cr = CR_OUT_OF_MEMORY;
break;
}
cr = CM_Get_Device_Interface_List((LPGUID)&GUID_DEVINTERFACE_VOLUME,
NULL,
DeviceInterfaceList,
DeviceInterfaceListLength,
CM_GET_DEVICE_INTERFACE_LIST_ALL_DEVICES);
} while (cr == CR_BUFFER_SMALL);
if (cr != CR_SUCCESS)
{
goto Exit;
}
for (CurrentInterface = DeviceInterfaceList;
*CurrentInterface;
CurrentInterface += wcslen(CurrentInterface) + 1)
{
PropertySize = sizeof(CurrentDevice);
cr = CM_Get_Device_Interface_Property(CurrentInterface,
&DEVPKEY_Device_InstanceId,
&PropertyType,
(PBYTE)CurrentDevice,
&PropertySize,
0);
if (cr != CR_SUCCESS)
{
goto Exit;
}
if (PropertyType != DEVPROP_TYPE_STRING)
{
goto Exit;
}
// Since the list of interfaces includes all interfaces, enabled or not, the
// device that exposed that interface may currently be non-present, so
// CM_LOCATE_DEVNODE_PHANTOM should be used.
cr = CM_Locate_DevNode(&Devinst,
CurrentDevice,
CM_LOCATE_DEVNODE_PHANTOM);
if (cr != CR_SUCCESS)
{
goto Exit;
}
// Query a property on the device. For example, the device description.
PropertySize = sizeof(DeviceDesc);
cr = CM_Get_DevNode_Property(Devinst,
&DEVPKEY_Device_DeviceDesc,
&PropertyType,
(PBYTE)DeviceDesc,
&PropertySize,
0);
if (cr != CR_SUCCESS)
{
goto Exit;
}
if (PropertyType != DEVPROP_TYPE_STRING)
{
goto Exit;
}
Index++;
}
Exit:
if (DeviceInterfaceList != NULL)
{
HeapFree(GetProcessHeap(),
0,
DeviceInterfaceList);
}
return;
}
特定のデバイスからプロパティを取得する
この例では、特定のデバイスのデバイス インスタンス パスを取得し、SetupDiGetDeviceProperty を使用してプロパティを取得します。
VOID
GetDevicePropertySpecificDeviceSetupapi(
VOID
)
{
HDEVINFO DeviceInfoSet = INVALID_HANDLE_VALUE;
SP_DEVINFO_DATA DeviceInfoData;
WCHAR DeviceDesc[2048];
DEVPROPTYPE PropertyType;
DeviceInfoSet = SetupDiCreateDeviceInfoList(NULL, NULL);
if (DeviceInfoSet == INVALID_HANDLE_VALUE)
{
goto Exit;
}
ZeroMemory(&DeviceInfoData, sizeof(DeviceInfoData));
DeviceInfoData.cbSize = sizeof(DeviceInfoData);
if (!SetupDiOpenDeviceInfo(DeviceInfoSet,
MY_DEVICE,
NULL,
0,
&DeviceInfoData))
{
// The error can be retrieved with GetLastError();
goto Exit;
}
// Query a property on the device. For example, the device description.
if (!SetupDiGetDeviceProperty(DeviceInfoSet,
&DeviceInfoData,
&DEVPKEY_Device_DeviceDesc,
&PropertyType,
(PBYTE)DeviceDesc,
sizeof(DeviceDesc),
NULL,
0)) {
// The error can be retrieved with GetLastError();
goto Exit;
}
if (PropertyType != DEVPROP_TYPE_STRING)
{
goto Exit;
}
Exit:
if (DeviceInfoSet != INVALID_HANDLE_VALUE)
{
SetupDiDestroyDeviceInfoList(DeviceInfoSet);
}
return;
}
この例では、特定のデバイスのデバイス インスタンス パスを取得し、CM_Get_DevNode_Property を使用してプロパティを取得します。
void
GetDevicePropertySpecificDeviceCfgmgr32(
VOID
)
{
CONFIGRET cr = CR_SUCCESS;
DEVINST Devinst;
WCHAR DeviceDesc[2048];
DEVPROPTYPE PropertyType;
ULONG PropertySize;
// If MY_DEVICE could be a non-present device, CM_LOCATE_DEVNODE_PHANTOM
// should be used in place of CM_LOCATE_DEVNODE_NORMAL.
cr = CM_Locate_DevNode(&Devinst,
MY_DEVICE,
CM_LOCATE_DEVNODE_NORMAL);
if (cr != CR_SUCCESS)
{
goto Exit;
}
// Query a property on the device. For example, the device description.
PropertySize = sizeof(DeviceDesc);
cr = CM_Get_DevNode_Property(Devinst,
&DEVPKEY_Device_DeviceDesc,
&PropertyType,
(PBYTE)DeviceDesc,
&PropertySize,
0);
if (cr != CR_SUCCESS)
{
goto Exit;
}
if (PropertyType != DEVPROP_TYPE_STRING)
{
goto Exit;
}
Exit:
return;
}
デバイスを無効にする
この例では、CfgMgr32 を使用してデバイスを無効にする方法を示します。 SetupApi でこれを行うには、DICS_DISABLEを指定して、DIF_PROPERTYCHANGE の InstallFunction で SetupDiCallClassInstaller を使用します。
注: 既定では、SetupDiCallClassInstaller を呼び出すと、再起動後もデバイスは無効になります。 CM_Disable_DevNodeを呼び出すときに再起動後にデバイスを無効にするには、CM_DISABLE_PERSIST フラグを指定する必要があります。
cr = CM_Locate_DevNode(&devinst,
(DEVINSTID_W)DeviceInstanceId,
CM_LOCATE_DEVNODE_NORMAL);
if (cr != CR_SUCCESS) {
goto Exit;
}
cr = CM_Disable_DevNode(devinst, 0);
if (cr != CR_SUCCESS) {
goto Exit;
}
デバイスを有効にする
この例では、CfgMgr32 を使用してデバイスを有効化する方法を示します。 SetupApi でこれを行うには、DICS_ENABLE を指定して、DIF_PROPERTYCHANGE の InstallFunction で SetupDiCallClassInstaller を使用します。
cr = CM_Locate_DevNode(&devinst,
(DEVINSTID_W)DeviceInstanceId,
CM_LOCATE_DEVNODE_NORMAL);
if (cr != CR_SUCCESS) {
goto Exit;
}
cr = CM_Enable_DevNode(devinst, 0);
if (cr != CR_SUCCESS) {
goto Exit;
}
デバイスの再起動
この例では、CfgMgr32 を使用してデバイスを再起動する方法を示します。 SetupApi でこれを行うには、DICS_PROPCHANGE を指定して、DIF_PROPERTYCHANGE の InstallFunction で SetupDiCallClassInstaller を使用します。
cr = CM_Locate_DevNode(&devinst,
(DEVINSTID_W)DeviceInstanceId,
CM_LOCATE_DEVNODE_NORMAL);
if (cr != CR_SUCCESS) {
goto Exit;
}
cr = CM_Query_And_Remove_SubTree(devinst,
NULL,
NULL,
0,
CM_REMOVE_NO_RESTART);
if (cr != CR_SUCCESS) {
goto Exit;
}
cr = CM_Setup_DevNode(devinst,
CM_SETUP_DEVNODE_READY);
if (cr != CR_SUCCESS) {
goto Exit;
}
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示