Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

CM_Get_Device_ID (setupapi)
 
.
Summary
Retrieves the "device instance ID" for a specified device instance on the local machine. If the operation succeeds, the function returns CR_SUCCESS. Otherwise, it returns one of the CR_-prefixed error codes defined in Cfgmgr32.h.

C# Signature:

[DllImport("setupapi.dll", CharSet = CharSet.Auto)]
static extern int CM_Get_Device_ID(
   UInt32 dnDevInst,
   IntPtr buffer,
   int bufferLen,
   int flags
);

VB Signature:

Declare Function CM_Get_Device_ID Lib "setupapi.dll" (TODO) As TODO

Parameters:

deviceInstance, Caller-supplied device instance handle that is bound to the local machine.

buffer, Address of a buffer to receive a device instance ID string. The required buffer size can be obtained by calling CM_Get_Device_ID_Size, then incrementing the received value to allow room for the string's terminating NULL.

bufferLength, Caller-supplied length, in characters, of the buffer specified by Buffer.

flags, Not used, must be zero.

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

CMAPI CONFIGRET WINAPI  CM_Get_Device_ID(
   IN DEVINST  dnDevInst,
   OUT PTCHAR  Buffer,
   IN ULONG  BufferLen,
   IN ULONG  ulFlags
);

Tips & Tricks:

Please add some!

Sample Code:

Guid DiskGUID = new Guid(GUID_DEVINTERFACE_DISK);

// We start at the "root" of the device tree and look for all
// devices that match the interface GUID of a disk
IntPtr h = SetupDiGetClassDevs(ref DiskGUID, 0, IntPtr.Zero, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);
if (h.ToInt32() != INVALID_HANDLE_VALUE)
{
   bool Success = true;
   int i = 0;
   while (Success)
   {
     // create a Device Interface Data structure
     SP_DEVICE_INTERFACE_DATA dia = new SP_DEVICE_INTERFACE_DATA();
     dia.cbSize = Marshal.SizeOf(dia);

     // start the enumeration
     Success = SetupDiEnumDeviceInterfaces(h, IntPtr.Zero, ref DiskGUID, i, ref dia);
     if (Success)
     {
    // build a DevInfo Data structure
    SP_DEVINFO_DATA da = new SP_DEVINFO_DATA();
    da.cbSize = Marshal.SizeOf(da);

    // build a Device Interface Detail Data structure
    SP_DEVICE_INTERFACE_DETAIL_DATA didd = new SP_DEVICE_INTERFACE_DETAIL_DATA();
    didd.cbSize = 4 + Marshal.SystemDefaultCharSize; // trust me :)

    // now we can get some more detailed information
    int nRequiredSize = 0;
    int nBytes = BUFFER_SIZE;
    if (SetupDiGetDeviceInterfaceDetail(h, ref dia, ref didd, nBytes, ref nRequiredSize, ref da))
    {
      // current InstanceID is at the "USBSTOR" level, so we
      // need up "move up" one level to get to the "USB" level
      UInt32 ptrPrevious;
      CM_Get_Parent(out ptrPrevious, da.DevInst, 0);

      // Now we get the InstanceID of the USB level device
      IntPtr ptrInstanceBuf = Marshal.AllocHGlobal(nBytes);
      CM_Get_Device_ID(ptrPrevious, ptrInstanceBuf, nBytes, 0);
      string InstanceID = Marshal.PtrToStringAuto(ptrInstanceBuf, nBytes);

      Marshal.FreeHGlobal(ptrInstanceBuf);
    }
      }
    }
    i++;
  }
  SetupDiDestroyDeviceInfoList(h);

}

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Find References
Show Printable Version
Revisions