L_TBIsVisible

#include "LtTLB.h"

L_LTTLB_API L_INT L_TBIsVisible(pToolbar, pfVisible );

pTOOLBARHANDLE pToolbar;

pointer to a toolbar handle

L_BOOL * pfVisible;

visibility flag

Determines the visibility of the toolbar window.

Parameter Description
pToolbar Pointer to a toolbar handle.
pfVisible Point to a variable to be updated with the visibility status of the toolbar. Possible values are:
  Value Meaning
  TRUE The specified toolbar is visible.
  FALSE The specified toolbar is not visible.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes

Comments

To change the visibility status of the toolbar, call L_TBSetVisible.

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:

L_TBSetVisible.

Topics:

Getting and Setting Toolbar Characterisitcs

Example

This function will toggle the toolbar visibility state.

L_INT TBIsVisibleExample(pTOOLBARHANDLE pLeadToolbar ) 
{ 
   L_INT nRet; 
   nRet = L_TBIsValid ( pLeadToolbar ); 
   /* check the validity of the toolbar handle */ 
   if (SUCCESS == nRet ) 
   { 
      L_BOOL fVisible ; 
      /* Get the visibility state of the toolbar */ 
      nRet = L_TBIsVisible ( pLeadToolbar, &fVisible ) ; 
      if(nRet != SUCCESS) 
         return nRet; 
      if ( fVisible ) 
      { 
         nRet = L_TBSetVisible ( pLeadToolbar, FALSE ) ; /* Hide the toolbar */ 
         if(nRet != SUCCESS) 
            return nRet; 
      } 
      else 
      { 
         nRet = L_TBSetVisible ( pLeadToolbar, TRUE ) ; /* Show the toolbar */ 
         if(nRet != SUCCESS) 
            return nRet; 
      } 
      return SUCCESS ; 
   } 
   else 
      return nRet ; 
} 

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Toolbar C API Help