L_AnnClearTextTokenTable

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnClearTextTokenTable(hAutomation)

HANNOBJECT hAutomation;

/* handle of the automation object */

Removes all tokens from the text token table.

This function is available in the Document and Medical Imaging toolkits.

Parameter	Description
hAutomation	Handle of the automation object.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Call this function to delete ALL the tokens from the text token table. This function is used with the text annotation objects that support tokens, namely the following:

ANNOBJECT_AUTOMATION
ANNOBJECT_BUTTON
ANNOBJECT_NOTE
ANNOBJECT_PUSHPIN
ANNOBJECT_STAMP
ANNOBJECT_TEXT
ANNOBJECT_TEXTPOINTER

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_AnnDeleteTextTokenTable, L_AnnEnumerateTextTokenTable, L_AnnGetTextExpandTokens, L_AnnInsertTextTokenTable, L_AnnSetTextExpandTokens
Topics:	The Annotation Text Token Table
	Annotation Functions (Document/Medical only): Text Properties

Example

This example removes all of the tokens from the current text token table.

 L_INT AnnClearTextTokenTableExample(HANNOBJECT hAutomation)
{
   L_INT nRet = SUCCESS;
   nRet = L_AnnClearTextTokenTable(hAutomation);
   return nRet;
}