L_TBGetCallback

Summary

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

Syntax

#include "LtTLB.h"

L_LTTLB_API L_INT L_TBGetCallback (pToolbar, ppCallback, ppUserData )

Parameters

pTOOLBARHANDLE pToolbar

Pointer to a toolbar handle.

pTOOLBARCALLBACK * 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.

L_VOID **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

Value Meaning
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

See Also

Functions

Topics

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 ; 
} 
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Toolbar C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.