CLngUtils_interface.h File Reference

Interface for CLngUtils wrapper. More...

Go to the source code of this file.

Functions
IDRS_BOOL	CLngUtils_TestCompatibility (enum Language const lMainLng, enum Language const lSecLng, idrs_exception *pargException)
	TestCompatibility tests if two languages are compatible for an OCR context.
IDRS_BOOL	CLngUtils_TestCompatibility2 (const LanguageArray argLanguages, idrs_exception *pargException)
	TestCompatibility tests if the given languages can be mixed inside the same OCR context.
idrs_string	CLngUtils_ComputeCharset (enum Language const lLanguage, idrs_exception *pargException)
	ComputeCharset computes the character set for the given language.
idrs_string	CLngUtils_ComputeCharset2 (const LanguageArray xLanguages, idrs_exception *pargException)
	ComputeCharset computes the character set for the supplied LanguageArray object.
LanguageArray	CLngUtils_GetLanguageDetectionSupportedLanguages (idrs_exception *pargException)
	GetLanguageDetectionSupportedLanguages retrieves the list of languages supported by language detection.

Detailed Description

Interface for CLngUtils wrapper.

Function Documentation

CLngUtils_ComputeCharset()

idrs_string CLngUtils_ComputeCharset	(	enum Language const	lLanguage,
		idrs_exception *	pargException
	)

ComputeCharset computes the character set for the given language.

Parameters

lLanguage	The identifier for the language.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The character set.

CLngUtils_ComputeCharset2()

idrs_string CLngUtils_ComputeCharset2	(	const LanguageArray	xLanguages,
		idrs_exception *	pargException
	)

ComputeCharset computes the character set for the supplied LanguageArray object.

Parameters

xLanguages	The LanguageArray object containing the languages.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The character set for the provided languages

CLngUtils_GetLanguageDetectionSupportedLanguages()

LanguageArray CLngUtils_GetLanguageDetectionSupportedLanguages

(

idrs_exception *

pargException

)

GetLanguageDetectionSupportedLanguages retrieves the list of languages supported by language detection.

Returns

Array containing all languages supported by language detection

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CLngUtils_TestCompatibility()

IDRS_BOOL CLngUtils_TestCompatibility	(	enum Language const	lMainLng,
		enum Language const	lSecLng,
		idrs_exception *	pargException
	)

TestCompatibility tests if two languages are compatible for an OCR context.

TestCompatibility tests if the given two languages can be mixed inside the same OCR context.

Parameters

lMainLng	The identifier for the main language.
lSecLng	The identifier for the secondary language.
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if the first language accepts the given secondary language.
IDRS_FALSE	otherwise.

CLngUtils_TestCompatibility2()

IDRS_BOOL CLngUtils_TestCompatibility2	(	const LanguageArray	argLanguages,
		idrs_exception *	pargException
	)

TestCompatibility tests if the given languages can be mixed inside the same OCR context.

Parameters

argLanguages	Array containing the languages to be tested
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if the languages can be mixed.
IDRS_FALSE	otherwise.