SetupDiGetDeviceInterfaceDetail

来源:互联网 发布:中国科学院待遇 知乎 编辑:程序博客网 时间:2024/05/01 22:51

SetupDiGetDeviceInterfaceDetail

该函数返回设备接口的详细信息。

BOOL SetupDiGetDeviceInterfaceDetail(  _In_       HDEVINFO                         DeviceInfoSet,  _In_       PSP_DEVICE_INTERFACE_DATA        DeviceInterfaceData,  _Out_opt_  PSP_DEVICE_INTERFACE_DETAIL_DATA DeviceInterfaceDetailData,  _In_       DWORD                            DeviceInterfaceDetailDataSize,  _Out_opt_  PDWORD                           RequiredSize,  _Out_opt_  PSP_DEVINFO_DATA                 DeviceInfoData);

参数

  • DeviceInfoSet
      指向设备信息集的指针,它包含了所要接收信息的接口。该句柄通常由SetupDiGetClassDevs函数返回。
  • DeviceInterfaceData
      一个指向 SP_DEVICE_INTERFACE_DATA结构的指针,该结构指定了 DeviceInfoSet 参数中设备的接口。这个类型的指针通常由 SetupDiEnumDeviceInterfaces 函数返回。
  • DeviceInterfaceDetailData
      一个指向SP_DEVICE_INTERFACE_DETAIL_DATA结构的指针,该结构用于接收指定接口的信息。该参数是可选的且可以为NULL。如果DeviceInterfaceDetailSize 参数为0,该参数必须为NULL。如果该参数被指定,主调者必须在调用该函数之前,设置 SP_DEVICE_INTERFACE_DETAIL_DATA 结构的 cbSize 成员为 sizeof(SP_DEVICE_INTERFAC_DETAIL_DATA)。cbSize 成员总是包含数据结构的固定部分的长度。
  • DeviceInterfaceDetailDataSize
     DeviceInterfaceDetailData 参数指定的缓冲的大小。该缓冲的大小不能小于 (offsetof(SP_DEVICE_INTERFACE_DETAIL_DATA, DevicePath) + sizeof(TCHAR)) 字节。
    如果 DeviceInterfaceDetailData 参数为NULL,该参数必须为0.
  • RequiredSize
      一个指向变量的指针,该变量接收请求的 DeviceInterfaceDetailData 缓冲的大小。这个大小包含了结构的固定部分的大小再加上设备路径字符串的长度。该参数是可选的,也可以是NULL。
  • DeviceInfoData
      一个指向缓冲的指针,该缓冲接收关于支持请求的接口的设备的信息。主调者必须设置 DeviceInfoData.cbSize 成员为 sizeof(SP_DEVINFO_DATA)。该参数是可选的,也可以为NULL。

返回值

如果函数顺利完成,则返回TRUE,如果有错误,则返回FALSE。

备注

使用该函数来获得接口的细节,通常需要两个步骤:
1、获得请求的缓冲大小。
  调用SetupDiGetDeviceInterfaceDetail,并指定参数DeviceInterfaceDetailData = NULL,DeviceInterfaceDetailDataSize = 0, 以及一个有效的 RequiredSize 变量。调用之后函数会返回失败,并且在 RequiredSize中返回所需的缓冲区大小,通过调用GetLastError可以获取到ERROR_INSUFFICIENT_BUFFER。

2、分配一个合适的缓冲并再次调用函数来获得接口细节。
  由该函数返回的接口细节包括设备路径。不要试图解析设备路径符号名字。设备路径可以跨系统重用。该函数可以被用来获得DeviceInfoData。如果接口存在,但DeviceInterfaceDetailData 为NULL,该函数会失败。

要求

Versions: The SetupDiGetDeviceInterfaceDetail function is available in Microsoft Windows 2000 and later versions of Windows.

Headers: Declared in Setupapi.h. Include Setupapi.h.

Library: Contained in Setupapi.lib. Link to Setupapi.lib.

0 0