IoOpenDeviceInterfaceRegistryKey function (wdm.h)

Article
04/18/2022

The IoOpenDeviceInterfaceRegistryKey routine returns a handle to a registry key for storing information about a particular device interface instance.

Syntax

NTSTATUS IoOpenDeviceInterfaceRegistryKey(
  [in]  PUNICODE_STRING SymbolicLinkName,
  [in]  ACCESS_MASK     DesiredAccess,
  [out] PHANDLE         DeviceInterfaceRegKey
);

Parameters

[in] SymbolicLinkName

Pointer to a string identifying the device interface instance. This string was obtained from a previous call to IoGetDeviceInterfaces, IoGetDeviceInterfaceAlias, or IoRegisterDeviceInterface.

[in] DesiredAccess

Specifies the ACCESS_MASK value that represents the access the caller requires to the key, such as KEY_READ, KEY_WRITE, or KEY_ALL_ACCESS. See ZwCreateKey for a description of each KEY_XXX access right.

[out] DeviceInterfaceRegKey

Pointer to a returned handle to the requested registry key if the call is successful.

Return value

IoOpenDeviceInterfaceRegistryKey returns STATUS_SUCCESS if the call was successful. Possible error return values include the following.

Return code	Description
STATUS_OBJECT_NAME_NOT_FOUND	The routine was not able to locate a registry key for the device interface instance, probably due to an error in the SymbolicLinkName.
STATUS_OBJECT_PATH_NOT_FOUND	The routine was not able to locate a registry key for the device interface instance, probably due to an error in the SymbolicLinkName.
STATUS_INVALID_PARAMETER	Possibly indicates an error in the SymbolicLinkName.

Remarks

IoOpenDeviceInterfaceRegistryKey opens a nonvolatile subkey of the registry key for the device interface instance specified by SymbolicLinkName. Drivers can store information in this subkey that is specific to this instance of the device interface, such as the default resolution for a camera. User-mode applications can access this subkey using SetupDiXxx routines.

The driver must call ZwClose to close the handle returned from this routine when access is no longer required.

Callers of IoOpenDeviceInterfaceRegistryKey must be running at IRQL = PASSIVE_LEVEL in the context of a system thread.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 2000.
Target Platform	Universal
Header	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL (see Remarks section)
DDI compliance rules	HwStorPortProhibitedDDIs(storport), PowerIrpDDis(wdm)