PWRM_unregisterNotify
Application Program Interface
2-335
C Interface
Syntax
status = PWRM_unregisterNotify(notifyHandle);
Parameters
PWRM_NotifyHandle notifyHandle;/* handle to registered function */
Return Value
PWRM_Status
status;
/* returned status */
Reentrant
yes
Description
PWRM_unregisterNotify unregisters an event notification that was
registered by PWRM_registerNotify. For example, when an audio codec
device is closed, it no longer needs to be notified, and should unregister
for event notification.
The notifyHandle parameter is the parameter that was provided by
PWRM_registerNotify when the function was registered.
PWRM_unregisterNotify returns one of the following constants as a
status value of type PWRM_Status:
Constraints and
Calling Context
❏
This API cannot be called from a program’s main() function.
Example
PWRM_NotifyHandle notifyHandle1;
PWRM_registerNotify(PWRM_PENDINGSETPOINTCHANGE,
ALLSETPOINTSALLOWED, (Fxn)myNotifyFxn1,
(Arg)0x1111, ¬ifyHandle1, (Fxn *) &delayFxn1);
PWRM_unregisterNotify(notifyHandle1);
PWRM_unregisterNotify
Unregister for an event notification from PWRM
Name
Usage
PWRM_SOK
The function was successfully unregistered.
PWRM_EFAIL
A general failure occurred.
PWRM_EINVALIDHANDLE
Operation failed because notifyHandle is
invalid.