ANNENUMTEXTTOKENTABLECALLBACK Function
#include "l_bitmap.h"
L_INT pEXT_CALLBACK YourFunction(nTextTokenCount, nIndex, pTextToken, pUserData);
|
L_INT nTextTokenCount; |
/* total number of tokens in the text token table */ |
|
L_INT nIndex; |
/* index of the text token */ |
|
pANNTEXTTOKEN pTextToken; |
/* structure that defines the text token */ |
|
/* pointer to additional data */ |
Processes each text token in the annotation text token table from the L_AnnEnumerateTextTokenTable function. This function is called zero or more times as a result of a call to L_AnnEnumerateTextTokenTable.
|
Parameter |
Description |
|
nTextTokenCount |
Total number of tokens in the text token table. |
|
nIndex |
Index of the particular token. The index is zero-based. |
|
pTextToken |
A pANNTEXTTOKEN structure that defines the the text token. For more information, see the documentation for the pANNTEXTTOKEN structure. |
|
pUserData |
Void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of the L_AnnEnumerateTextTokenTable function.) Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The L_AnnEnumerateTextTokenTable function calls your callback function for each token in the annotation text token table. For example, suppose there are four entries in the text token table. A call to L_AnnEnumerateTextTokenTable will call your callback function four times—once for each token. For each of the four calls, nTextTokenCount will be 4. Since nIndex is zero-based, nIndex will be 0 in the first call to your callback function, and 3 in the last call to your callback function.
Example
For an example, refer to L_AnnEnumerateTextTokenTable.