LAnnToolBar::GetToolBarButtons

#include "ltwrappr.h"

virtual L_INT LAnnToolBar::GetToolBarButtons(pButtons, uStructSize, puButtons)

pANNBUTTON pButtons;

/* address of a variable to be updated */

L_UINT uStructSize;

/* size of the structure */

L_UINT * puButtons;

/* address of a variable to be updated */

Retrieves information about the buttons in the annotation toolbar. This function is available in the Document/Medical Toolkits.

Parameter

Description

pButtons

Pointer to an array of ANNBUTTON structures to be updated with information about the buttons in the annotation toolbar.

uStructSize

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

puButtons

Address of a variable to be updated with the number of buttons in the toolbar (number of entries in the pButtons array).

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Call this function once, with pButtons set to NULL. This will retrieve the number of buttons in the toolbar, updating puButtons. Next, allocate the appropriate amount of memory for the pButtons array, and call this function again to retrieve the button information.

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.

See Also

Functions:

LAnnotation::GetOptions, LAnnotation::SetOptions, LAnnToolBar::Create, LAnnToolBar::GetToolChecked, LAnnToolBar::SetToolChecked, LAnnToolBar::IsButtonVisible, LAnnToolBar::SetButtonVisible, LAnnToolBar::FreeToolBarButtons, LAnnToolBar::SetToolBarButtons, LAnnToolBar::GetToolBarInfo, LAnnToolBar::SetToolBarColumns, LAnnToolBar::SetToolBarRows

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Key Annotation Features

Example

For an example, refer to LAnnToolBar::FreeToolBarButtons.