HIDDelClient

Syntax

#include <cafe/hid.h>
    
HID_ERROR_CODE  HIDDelClient(HIDClient *p_client);

Parameters

p_client Pointer to the HIDClient data structure provided by the client to HID library. This data structure will be referenced by the HID library at runtime and should remain valid between HIDAddClient and HIDDelClient.

Return Values

HIDDelClient always returns HID_ERROR_NONE.

Description

HIDDelClient removes the specified HIDClient from the HID library. During a call to HIDDelClient any HID devices attached to the specified HID client will have pending transactions canceled and then detached from the client, other HID clients in the HID library will then receive attach notification for the HID device.

Do Not Call From

Background Do not call this function from the background.

See Also

HIDClient
HIDAttachCallback
HIDAddClient

Revision History

2013-05-08 Automated cleanup pass.
2011-09-29 Initial version.


CONFIDENTIAL