L_AnnGetAutoText
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_AnnGetAutoText(hObject, uItem, pText)
|
HANNOBJECT hObject; |
/* annotation automation object */ |
|
L_UINT uItem; |
/* constant for the specified item */ |
|
/* pointer to the variable to be updated */ |
Gets the character string for a menu or dialog box item associated with automated annotations. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
hObject |
Handle to the annotation automation object. |
|
uItem |
Constant that specifies the menu or dialog box item, which appears when the user presses the right mouse button. For lists of constants and their default values, refer to the following: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
pText |
Pointer to the buffer to be updated with the item's character string. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Before calling this function, call L_AnnGetAutoTextLen to get the length of the text you want to retrieve.
Use L_AnnSetAutoText to modify the automated menu item.
Before calling this function, you must declare a variable as a pointer to a character string. Then, pass the variable in the pText parameter. This function will update the variable with the automation item's character string.
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
Windows 95 / 98 / Me, Windows 2000 / XP.
See Also
|
Functions: |
L_AnnGetAutoTextLen, L_AnnSetAutoText, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
Annotation Functions (Document/Medical only): Automation Properties |
Example
/* This example adds " - New" to the current "&Undo" menu item. */
HANNOBJECT hAutoObject; /* Automation object */
void TestAnnAutoText(void)
{
L_TCHAR L_FAR * pText; /* The object’s text */
HGLOBAL hText; /* Handle for memory management */
L_UINT TextLength; /* Length of the object’s text */
/* Get the length of the current text */
L_AnnGetAutoTextLen(hAutoObject, ANNAUTOTEXT_MENU_UNDO, &TextLength);
/* Add six characters to the length for our new text */
TextLength = TextLength + 6;
/* Allocate and lock a zero-filled buffer for the text */
hText = GlobalAlloc(GPTR, TextLength * sizeof (L_TCHAR));
pText = (L_TCHAR L_FAR *)GlobalLock( hText );
/* Get the current text */
L_AnnGetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, pText);
/* Add " - New" to the end of the current text */
lstrcat(pText, TEXT(" - New"));
L_AnnSetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, pText);
/* Free memory that we no longer need */
GlobalFree(hText);
return;
}