USB Libraries Help > USB Host Libraries > USB Audio v1.0 Host Client Driver Library > Library Interface > a) Audio Device Access Functions > USB_HOST_AUDIO_V1_DeviceObjHandleGet Function
MPLAB Harmony USB Stack
USB_HOST_AUDIO_V1_DeviceObjHandleGet Function

This function returns the device object handle for this Audio v1.0 Device. This returned handle can be used by the application to perform device-level operations, such as obtaining the string descriptors.

C
USB_HOST_DEVICE_OBJ_HANDLE USB_HOST_AUDIO_V1_DeviceObjHandleGet(
    USB_HOST_AUDIO_V1_OBJ audioDeviceObj
);
Preconditions

None.

Parameters
Parameters 
Description 
audioDeviceObj 
Audio V1.0 device object handle returned in the USB_HOST_AUDIO_V1_ATTACH_EVENT_HANDLER function. 
Returns

Will return a valid device object handle if the device is still connected to the system. Otherwise, the function will return USB_HOST_DEVICE_OBJ_HANDLE_INVALID.

Remarks

None.