HIDCloseAsync

Syntax

#include <revolution/hid.h>
HIDError HIDCloseAsync (
            HIDSetupHandler hsh,
            u32 user
            );

Arguments

HIDSetupHandler hsh The pointer to the HIDSetupHandler user callback function. The HIDCloseAsync function calls this callback function to report the results of cleaning-up and closing. During a debug build, ASSERTMSG will be performed if HIDSetupHandler is invalid.
u32 user User-defined parameter. This variable is passed to the HIDSetupHandler callback function defined by the user.

Return Values

HID_ERROR_OK Function was successful. The result is reported asynchronously by the user-defined HIDSetupHandler callback function.
HID_ERROR_NOT_OPEN The HID library is not open.
HID_ERROR_FIRMWARE_MALFUNCTION The HID library has received an error from the firmware.
HID_ERROR_BUSY The HID library is busy. The user can try again later.

Description

Cleans up and closes the HID library after it is no longer needed for run-time use. The user can use the HID API functions during the time between the call to HIDOpenAsync and the call to HIDCloseAsync.

See Also

HIDOpenAsync
HIDSetupHandler
HIDError

Revision History

2008/09/24 Initial version.



CONFIDENTIAL