L_TBGetCallback

#include "LtTLB.h"

L_LTTLB_API L_INT L_TBGetCallback (pToolbar, ppCallback, ppUserData )

pTOOLBARHANDLE pToolbar;

/* pointer to a toolbar handle */

pTOOLBARCALLBACK * ppCallback;

/* pointer to a pointer to a callback */

L_VOID **ppUserData;

/* pointer to a pointer to user defined data */

Returns the current callback function used to notify the user about toolbar events.

Parameter

Description

pToolbar

Pointer to a toolbar handle.

ppCallback

Pointer to the current callback function set by the user. If there is no callback currently set by the user this function will return NULL.

ppUserData

Void pointer to be updated with the value of any user defined data associated with the callback. If you are not interested in the user defined data, pass NULL for this parameter.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes

Comments

To set the callback function used to notify the user of toolbar events, call L_TBSetCallback.

Required DLLs and Libraries

LTTLB

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

TOOLBARCALLBACK, L_TBSetCallback

Topics:

Receiving Toolbar Events

Example

L_BOOL TBGetCallbackExample (pTOOLBARHANDLE pLeadToolbar, L_INT *nRet )
{
   /* check the validity of the toolbar handle */
   *nRet = L_TBIsValid ( pLeadToolbar );
   if ( *nRet == SUCCESS  )
   {
      pTOOLBARCALLBACK * pCallback = NULL;
      L_VOID * pUserData = NULL;

      /* get the current toolbar callback */
      *nRet = L_TBGetCallback ( pLeadToolbar, pCallback, &pUserData ) ;

      if ( NULL != pCallback )
         return TRUE ;
      else
         return FALSE ;
   }
   else
      return FALSE ;
}