IOCTL_USB_GET_ROOT_HUB_NAME - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// usbioctl.h

// CTL_CODE(0x0022, 0x102, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_USB_GET_ROOT_HUB_NAME 0x00220408
View the official Windows Driver Kit DDI reference
// usbuser.h

// CTL_CODE(0x0022, 0x102, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define IOCTL_USB_GET_ROOT_HUB_NAME 0x00220408
View the official Win32 API reference

NtDoc

No description available.

Windows Driver Kit DDI reference (ni-usbioctl-ioctl_usb_get_root_hub_name)

IOCTL_USB_GET_ROOT_HUB_NAME IOCTL

Description

The IOCTL_USB_GET_ROOT_HUB_NAME I/O control request is used with the USB_ROOT_HUB_NAME structure to retrieve the symbolic link name of the root hub.

IOCTL_USB_GET_ROOT_HUB_NAME is a user-mode I/O control request. This request targets the USB host controller (GUID_DEVINTERFACE_USB_HOST_CONTROLLER).

Parameters

Major code

Input buffer

None.

Input buffer length

None.

Output buffer

On output, the AssociatedIrp.SystemBuffer member points to a USB_ROOT_HUB_NAME structure that contains the symbolic link name of the root hub. The leading "\xxx\ " text is not included in the retrieved string.

Output buffer length

The size of a USB_ROOT_HUB_NAME structure.

Input/output buffer

Input/output buffer length

Status block

The USB stack sets Irp->IoStatus.Status to STATUS_SUCCESS if the request is successful. Otherwise, the USB stack sets Status to the appropriate error condition, such as STATUS_INVALID_PARAMETER or STATUS_INSUFFICIENT_RESOURCES.

If the root hub is removed or stopped, the request returns STATUS_SUCCESS but the string is NULL.

See also

USB_ROOT_HUB_NAME


Win32 API reference (ni-usbuser-ioctl_usb_get_root_hub_name)

IOCTL_USB_GET_ROOT_HUB_NAME IOCTL

Description

The IOCTL_USB_GET_ROOT_HUB_NAME I/O control request is used with the USB_ROOT_HUB_NAME structure to retrieve the symbolic link name of the root hub.

IOCTL_USB_GET_ROOT_HUB_NAME is a user-mode I/O control request. This request targets the USB host controller (GUID_DEVINTERFACE_USB_HOST_CONTROLLER).

Parameters

Input buffer

None.

Input buffer length

None.

Output buffer

On output, the AssociatedIrp.SystemBuffer member points to a USB_ROOT_HUB_NAME structure that contains the symbolic link name of the root hub. The leading "\xxx\ " text is not included in the retrieved string.

Output buffer length

The size of a USB_ROOT_HUB_NAME structure.

Input/output buffer

Input/output buffer length

Status block

The USB stack sets Irp->IoStatus.Status to STATUS_SUCCESS if the request is successful. Otherwise, the USB stack sets Status to the appropriate error condition, such as STATUS_INVALID_PARAMETER or STATUS_INSUFFICIENT_RESOURCES.

If the root hub is removed or stopped, the request returns STATUS_SUCCESS but the string is NULL.

See also

USB_ROOT_HUB_NAME