L_TBIsVisible

#include "LtTLB.h"

L_INT EXT_FUNCTION 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 ToggleToolbar (pTOOLBARHANDLE pLeadToolbar )
{
   if (SUCCESS == L_TBIsValid ( pLeadToolbar ) ) /* check the validity of the toolbar handle */
   {
      L_BOOL fVisible ;

      /* Get the visibility state of the toolbar */
      L_TBIsVisible ( pLeadToolbar, &fVisible ) ;

      if ( fVisible )
      {
         /* Hide the toolbar */
         L_TBIsVisible ( pLeadToolbar, FALSE ) ;
      }
      else
      {
         /* Show the toolbar */
         L_TBIsVisible ( pLeadToolbar, TRUE ) ;
      }

      return SUCCESS ;
   }
   else
   {
      return FAILURE ;
   }
}