L_AnnDeleteTextTokenTable

Show in webframe

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnDeleteTextTokenTable(hAutomation, cToken)

HANNOBJECT hAutomation;	/* handle of the automation object */
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
hAutomation	Handle of the automation object.
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:

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

Win32, x64.

See Also

Functions:	L_AnnClearTextTokenTable, L_AnnEnumerateTextTokenTable, L_AnnGetTextExpandTokens, L_AnnInsertTextTokenTable, L_AnnSetTextExpandTokens
Topics:	The Annotation Text Token Table
	Annotation Functions (Document/Medical only): Text Properties

Example

The predefined Text Token Table has 'Y' defined to be the four digit year. This example deletes the 'Y' token from the token table.

 L_INT AnnDeleteTextTokenTableExample(HANNOBJECT hAutomation)
{
   L_INT nRet;
   ANNTEXTTOKEN TextToken;

   TextToken.uStructSize      = sizeof(ANNTEXTTOKEN);
   TextToken.cToken           = 'Y';
   TextToken.pszDesc          = TEXT("Two Digit Month");
   TextToken.pszTokenString   = NULL;
   TextToken.nTokenType       = ANNTOKEN_DATE_MM;
   nRet = L_AnnInsertTextTokenTable(hAutomation, &TextToken);
   if(nRet != SUCCESS)
      return nRet;
  
   nRet = L_AnnDeleteTextTokenTable(hAutomation, 'Y');
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}