Microsoft Windows CE 3.0  

IOCTL_HID_ATTACH

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This control code notifies the HID class driver that an application needs to use a device.

Parameters

hDevice
Handle to the HID class device.
dwIoControlCode
Specifies this code.
lpInBuffer
Pointer to an input buffer containing an SHiddiAttachstructure.
nInBufferSize
Specifies the length of the input buffer.
lpOutBuffer
Pointer to an output buffer containing SHiddiAttach. Must be equal to lpInBuffer.
nOutBufferSize
Specifies the length of the output buffer; must be the same as nInBufferSize.
lpBytesReturned
Specifies the total number of bytes returned.
lpOverlapped
NULL.

Remarks

The input and output buffer pointers and lengths must be identical. The buffer must contain an SHiddiAttachstructure that is used for both input and output. The device to attach may be specified by ID or by type. If the structure's dwIdmember is 0, the device is being specified by type. Otherwise, the dwIdmember contains the device's ID. If the device is being specified by type, the actual device attached is the first one that the HID class driver finds of the correct type. Before returning, the HID class driver must modify SHiddiAttachto reflect the actual ID and type of the attached device.

This I/O control code is also used to detach an attached device when the bAttachingmember of SHiddiAttachis set to FALSE. Devices can only be detached by ID; the dwDevTypemember is ignored when detaching. After a successful detach, the HID class driver should not modify SHiddiAttachbut should return a 0-byte output length.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later      
Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.


 Last updated on Tuesday, July 13, 2004

© 2004 Microsoft Corporation. All rights reserved.