L_DocGetUserDictionarySectionItem

#include "ltdoc.h"

L_LTDOC_API L_INT L_DocGetUserDictionarySectionItem(hDoc, pSection, pItem, nSize, puMask, bFirst)

L_HDOC hDoc;

/* handle to the OCR document */

L_CHAR * pSection;

/* string containing the section name */

L_WCHAR * pItem;

/* pointer to be updated */

L_INT nSize;

/* buffer size */

L_UINT32 * puMask;

/* pointer to be updated */

L_BOOL bFirst;

/* flag */

Gets section items from the specified section of the user dictionary.

Parameter

Description

hDoc

Handle to the OCR document.

pSection

Name of the section of the User dictionary whose items are to be listed.

pItem

Pointer to a buffer to get the first UNICODE item of the item-list.

nSize

Specifies the size of the buffer in bytes.

puMask

Pointer to a variable to hold the item's attribute. Valid values are:

 

Value

Meaning

 

USER_DICT_LITERAL

[0x0000] Used literal

 

USER_DICT_REGULAR_EXPRESSION

[0x0001] used regular expression

 

bFirst

Flag specifying which item to get. Valid values are:

 

Value

Meaning

 

TRUE

get the first section item in the specified section

 

FALSE

gets the next section item in the specified section

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function returns the item from the pSection section of the User dictionary.

Before calling this function, you must allocate a buffer with sufficient size to accommodate the current pItem parameter.

Call this function multiple times to get each of the items in a user dictionary section. The first time you call it, pass TRUE for bFirst. In each subsequent call, pass FALSE for bFirst, and LEADTOOLS will get the next item from the specified section. 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_DocGetUserDictionarySection, L_DocAddItemToUserDictionary, L_DocRemoveItemFromUserDictionary

Topics:

OCR Functions: User Dictionary

 

Working with a Dictionary

Example

For an example, refer to L_DocGetUserDictionary.