L_AnnGetToolBarInfo

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetToolBarInfo(hwndToolBar, pInfo, uStructSize)

HWND hwndToolBar;

/* window handle for the toolbar */

pANNTOOLBARINFO pInfo;

/* address of the variable to be updated */

L_UINT uStructSize;

/* size in bytes, of the structure pointed to by pInfo */

Gets information about the annotation toolbar.

Parameter

Description

hwndToolBar

Window handle for the toolbar. You get the window handle when you create the toolbar using the L_AnnCreateToolBar function.

pInfo

Address of the ANNTOOLBARINFO variable to be updated with the toolbar information.

uStructSize

Size in bytes, of the structure pointed to by pInfo, for versioning. Use sizeof (ANNTOOLBARINFO).

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To change the number of rows, call L_AnnSetToolBarRows. To change the number of columns, call L_AnnSetToolBarColumns.

Required DLLs and Libraries

LTANN

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

Platforms

Win32, x64.

See Also

Functions:

L_AnnCreateToolBar, L_AnnGetToolBarChecked, L_AnnSetToolBarChecked, L_AnnGetToolBarButtonVisible, L_AnnSetToolBarButtonVisible, L_AnnFreeToolBarButtons, L_AnnSetToolBarButtons, L_AnnFreeToolBarButtons, L_AnnSetToolBarColumns, L_AnnSetToolBarRows

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Implementing an Automated Annotation Program

 

Obtaining Annotation Object Information

Example

 L_INT AnnGetToolBarInfoExample(HWND ToolbarWnd)
{
   L_INT nRet;
   ANNTOOLBARINFO Info;
   L_TCHAR        cs[256];

   nRet = L_AnnGetToolBarInfo(ToolbarWnd, &Info, sizeof(ANNTOOLBARINFO));
   if(nRet != SUCCESS)
      return nRet;
   wsprintf(cs, TEXT("There are %d buttons\n%d rows\n%d columns\nin the toolbar."),
      Info.uButtons, Info.uRows, Info.uColumns);
   MessageBox(NULL, cs, TEXT(""), MB_OK);

   nRet = L_AnnSetToolBarColumns(ToolbarWnd, Info.uColumns + 1);
   if(nRet != SUCCESS)
      return nRet;
   MessageBox(NULL, TEXT("The toolbar now has an added column.\n"), TEXT(""), MB_OK);

   nRet = L_AnnSetToolBarRows(ToolbarWnd, Info.uRows + 1);
   if(nRet != SUCCESS)
      return nRet;
   MessageBox(NULL, TEXT("The toolbar now has one added row."), TEXT(""), MB_OK);
   return SUCCESS;
}