L_AnnGetAutoText
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetAutoText(hObject, uItem, pText, puLen)
|
HANNOBJECT hObject; |
/* annotation automation object */ |
|
L_UINT uItem; |
/* constant for the specified item */ |
|
L_TCHAR *pText; |
/* pointer to the variable to be updated */ |
|
L_SIZE_T *puLen; |
/* 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. |
|
puLen |
Pointer to variable to be updated with the length of the item's current character string. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To use this function:
|
1. |
Call this function passing pText as NULL to obtain the text length in the puLen parameter. |
|
2. |
Allocate a buffer of size (*puLen + 1). |
|
3. |
Call this function with passing the allocated buffer to the pText parameter to obtain the text. |
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 2000 / XP/Vista.
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.
L_INT AnnAutoTextExample(HANNOBJECT hAutoObject)/* Automation object */
{
L_INT nRet = SUCCESS;
L_TCHAR* pText = NULL; // The object’s text
HGLOBAL hText = 0; // Handle for memory management
L_SIZE_T nTextLength = 0; // Length of the object’s text
// Get the length of the current text
nRet = L_AnnGetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, NULL, &nTextLength);
if(nRet != SUCCESS)
return nRet;
// Allocate and lock a zero-filled buffer for the text
hText = GlobalAlloc(GPTR, (nTextLength + 6) * sizeof (L_TCHAR));
pText = (L_TCHAR *)GlobalLock( hText );
// Get the current text
nRet = L_AnnGetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, pText, &nTextLength);
if(nRet != SUCCESS)
return nRet;
//Add " - New" to the end of the current text
lstrcat(pText, TEXT(" - New"));
nRet = L_AnnSetAutoText(hAutoObject, ANNAUTOTEXT_MENU_UNDO, pText);
if(nRet != SUCCESS)
return nRet;
// Free memory that we no longer need
GlobalFreePtr(pText);
return SUCCESS;
}