Collapse All Expand All

LAnnAutomation::ClearTextTokenTable

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::ClearTextTokenTable()

Removes all tokens from the text token table.

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:

• LAnnAutomation

• LAnnButton

• LAnnNote

• LAnnPushPin

• LAnnStamp

• LAnnText

• LAnnTextPointer

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:	Class Members
Topics:	Annotation Functions: Object Properties
	Implementing Annotations
	Automated User Interface for Annotations
	Annotation Functions: Creating and Deleting Annotations
	Types of Annotations
	Annotation Functions: Implementing Custom Annotations
	Annotation Functions: Creating Custom Annotations
	Fixed Annotations
	Minimizing Flicker With Double Buffering
	Annotation Functions: Working with the Toolbar

Example

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

L_INT LAnnAutomation_ClearTextTokenTableExample(LAnnAutomation *pLAutomation) 
{
   return pLAutomation->ClearTextTokenTable();
}