Developer

API Reference

HANDLERDESC_Free()

Brew Release
Brew MP 1.0.2
See Also
- HandlerDesc
- IHandler_SetHandler()
- PFNFREEHANDLER
Description

This macro calls the free function contained in the referenced HandlerDesc data structure. An application that intalls a free function when overriding the default event handler should call HANDLERDESC_Free() at the end of that free function to ensure that the previous handler's allocated context memory is cleaned up.
Parameters
  • pdesc
    []:
    Pointer to a HandlerDesc data structure that contains a pointer to the free function to call.
Prototype
   HANDLERDESC_Free(HandlerDesc *pdesc);
Return
None
Side Effect
None
Comment
When the installed free function is called by the IHandler, it must NOT call back into the object through the context pointer (pCxt). For example, in a free function installed for a form, you must not call an IForm function with the form pointer, because the form is in the process of being destroyed and is in an indeterminate state. The free function should only use the pointer to access the installed handler's own members that need to be cleaned up.
  • Follow