L_ContainerGetCallback

#include "LtCon.h"

L_LTCON_API L_INT L_ContainerGetCallback(pContainer, ppCallback, ppUserData)

pCONTAINERHANDLE pContainer;	pointer to a container handle
pCONTAINERCALLBACK * ppCallback;	pointer to get the user-defined container callback
L_VOID **ppUserData;	pointer to get the user-defined data

Gets the current user installed callback function that is used to inform the user about the container events.

Parameter	Description
pContainer	Pointer to a container handle.
ppCallback	Pointer to the variable to be updated with the current user callback function address.
ppUserData	Pointer to the variable to be updated with a pointer to the current user data.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

If there is no user callback function current installed the function return NULL for the ppCallback and ppUserData.

Required DLLs and Libraries

LTCON

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

Example

This function will determine if the container is installed or not.

L_BOOL ContainerGetCallbackExample(pCONTAINERHANDLE      pContainer, 
pCONTAINERCALLBACK*   ppConCallback, 
L_INT * nRet, 
L_VOID **ppUserData) 
{ 
   *nRet = L_ContainerIsValid ( pContainer ); 
   if ( *nRet == SUCCESS  ) /* check the validity of container handle */ 
   { 
      /* get the container callback functoin pointer */ 
      *nRet = L_ContainerGetCallback ( pContainer, ppConCallback, ppUserData ) ; 
      if(*nRet != SUCCESS) 
         return FALSE; 
      if ( NULL != *ppConCallback ) 
      { 
         return TRUE ; 
      } 
      else 
      { 
         return FALSE ; 
      } 
   } 
   else 
   { 
      return FALSE ; 
   } 
}

Help Version 19.0.2017.10.27

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Container and Automation C API Help

Introduction

Version History

Features of LEADTOOLS

Redistributables/Files To Be Included With Your Application

Quick Reference

Tutorials

Function References

Functions:	L_ContainerSetCallback
Topics:	Using the Container Callback