L_TBRemoveButton
#include "ltTLB.h"
L_LTTLB_API L_INT L_TBRemoveButton( pToolbar, uButtonId )
pTOOLBARHANDLE pToolbar; |
/* pointer to a toolbar handle */ |
L_UINT uButtonId; |
/* button Id */ |
Removes a button from the toolbar.
Parameter |
Description |
pToolbar |
Pointer to a toolbar handle. |
uButtonId |
Button identifier that indicates the button to be removed. Note if this button is the only remaining button in its tool, the whole tool is removed too. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes |
Comments
To add a button to a toolbar, call L_TBAddButton.
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_TBAddButton, L_TBGetButtonInfo, L_TBSetButtonInfo, L_TBGetToolbarInfo, L_TBSetToolbarInfo |
Topics: |
Example
This example will remove all buttons from a given toolbar.
L_INT TBRemoveButtonExample( pTOOLBARHANDLE pToolbar ) { L_INT nRet; LTOOLBARINFO ToolbarInfo; L_UINT i, j; /* get toolbar info */ ZeroMemory(&ToolbarInfo, sizeof(LTOOLBARINFO) ); nRet = L_TBGetToolbarInfo ( pToolbar, &ToolbarInfo, sizeof(LTOOLBARINFO) ); if(nRet != SUCCESS) return nRet; /* iterate through tools */ for( i = 0; i < ToolbarInfo.uToolsCount; i++ ) { /* remove all buttons of this tool */ for( j = 0; j < ToolbarInfo.pTools[ i ].uButtonsCount; i++ ) { nRet = L_TBRemoveButton( pToolbar, ToolbarInfo.pTools[ i ].pButtons[ j ].uID ); if(nRet != SUCCESS) return nRet; } } /* free the info structure */ nRet = L_TBFreeToolbarInfo ( pToolbar, &ToolbarInfo ); if(nRet != SUCCESS) return nRet; return SUCCESS; }