LAnnAutomation::DeleteTextTokenTable

Summary

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

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::DeleteTextTokenTable(cToken)

Parameters

L_TCHAR 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

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

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');  
} 

Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.