L_DocGetUserDictionarySection

#include "ltdoc.h"

L_INT EXT_FUNCTION L_DocGetUserDictionarySection(hDoc, pSection, nSize, bFirst)

L_HDOC hDoc;

/* handle to the OCR document */

L_CHAR L_FAR * pSection;

/* pointer to a buffer to be updated */

L_INT nSize;

/* buffer size */

L_BOOL bFirst;

/* flag */

Gets user dictionary sections.

Parameter

Description

hDoc

Handle to the OCR document.

pSection

Pointer to a buffer to be updated with the name of the section, specified in the bFirst parameter, in the User dictionary.

nSize

Specifies the size of the buffer in bytes.

bFirst

Flag specifying which section to get. Valid values are:

 

Value

Meaning

 

TRUE

Get the first section in the user dictionary

 

FALSE

Gets the next section in the user dictionary

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Gets a list of user dictionary sections.

The lengths of each section name never exceeds MAX_SECTION_NAME_LENGTH characters (including the terminating zero).

Call this function multiple times to get each section in a user dictionary. The first time you call it, pass TRUE for bFirst. In each subsequent call, pass FALSE for bFirst, and LEADTOOLS will get the next section from the specified dictionary. To re-start the process, call this function again, and pass TRUE for bFirst.

Required DLLs and Libraries

LTDOC

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_DocSetUserDictionary, L_DocGetUserDictionary, L_DocGetUserDictionaryState, L_DocGetUserDictionarySectionItem, L_DocAddItemToUserDictionary, L_DocRemoveItemFromUserDictionary

Topics:

OCR Functions: User Dictionary

 

Working with a Dictionary

Example

For an example, refer to L_DocGetUserDictionary.