LAnnAutomation::DeleteTextTokenTable

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::DeleteTextTokenTable(cToken)

L_TCHAR cToken;

/* character representing the token to delete from the text token table */

Call this function to delete a text token from the annotation text token table.

Parameter

Description

cToken

Character representing the token to delete from the text token table. For example, to delete token "#c" from the text token table, pass c for cToken.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Call this function to delete the token #<cToken> from the text token table.

This function returns SUCCESS if cToken is successfully deleted, or if cToken was not already in the text token table. This function is used with the text annotation objects that support tokens, namely the following:

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

// The predefined Text Token Table has 'Y' defined to be the four digit year

// This sample deletes this token from the token table

L_INT DeleteTextTokenTableExample(LAnnAutomation *pLAutomation) 
{
   return pLAutomation->DeleteTextTokenTable('Y'); 
}