CSearchMatch_interface.h File Reference

Interface for CSearchMatch wrapper. More...

Go to the source code of this file.

Functions
unsigned int	CSearchMatch_GetPageIndex (const CSearchMatch argCSearchMatch, idrs_exception *pargException)
	Gets the 0-based index of the page where the part is located.
IDRS_RECT	CSearchMatch_GetBoundingBox (const CSearchMatch argCSearchMatch, idrs_exception *pargException)
	Gets the coordinates of the part on the page.
const idrs_string	CSearchMatch_GetFormattedText (const CSearchMatch argCSearchMatch, idrs_exception *pargException)
	Gets a formatted version of the matched text. Formatting includes:
const idrs_string	CSearchMatch_GetRawText (const CSearchMatch argCSearchMatch, idrs_exception *pargException)
	Gets the matched text as written on the page.
const CSearchMatch	CSearchMatch_GetFollower (const CSearchMatch argCSearchMatch, idrs_exception *pargException)
	Gets the follower match for this match available in case of chained search.
const idrs_string	CSearchMatch_GetIdentifier (const CSearchMatch argCSearchMatch, idrs_exception *pargException)
	Retrieves the identifier of the matched search context.
CSearchMatchArray	ArrayInterface_Create_CSearchMatchArray (idrs_exception *pargException)
	Creates a new CSearchMatchArray object.

Detailed Description

Interface for CSearchMatch wrapper.

Function Documentation

ArrayInterface_Create_CSearchMatchArray()

CSearchMatchArray ArrayInterface_Create_CSearchMatchArray

(

idrs_exception *

pargException

)

Creates a new CSearchMatchArray object.

Parameters

pargException

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

Returns

The newly created CSearchMatchArray

CSearchMatch_GetBoundingBox()

IDRS_RECT CSearchMatch_GetBoundingBox	(	const CSearchMatch	argCSearchMatch,
		idrs_exception *	pargException
	)

Gets the coordinates of the part on the page.

Returns

The coordinates of the part on the page

Parameters

argCSearchMatch	CSearchMatch handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSearchMatch_GetFollower()

const CSearchMatch CSearchMatch_GetFollower	(	const CSearchMatch	argCSearchMatch,
		idrs_exception *	pargException
	)

Gets the follower match for this match available in case of chained search.

Returns

The follower match

Parameters

argCSearchMatch	CSearchMatch handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSearchMatch_GetFormattedText()

const idrs_string CSearchMatch_GetFormattedText	(	const CSearchMatch	argCSearchMatch,
		idrs_exception *	pargException
	)

Gets a formatted version of the matched text. Formatting includes:

• fixing whitespaces,
• applying standard delimiters to numbers to facilitate parsing,
• applying standard date format,
• etc.

Returns

The formatted text

Parameters

argCSearchMatch	CSearchMatch handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSearchMatch_GetIdentifier()

const idrs_string CSearchMatch_GetIdentifier	(	const CSearchMatch	argCSearchMatch,
		idrs_exception *	pargException
	)

Retrieves the identifier of the matched search context.

Returns

The identifier associated with the search context.

Parameters

argCSearchMatch	CSearchMatch handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSearchMatch_GetPageIndex()

unsigned int CSearchMatch_GetPageIndex	(	const CSearchMatch	argCSearchMatch,
		idrs_exception *	pargException
	)

Gets the 0-based index of the page where the part is located.

Returns

The 0-based index of the page where the part is located

Parameters

argCSearchMatch	CSearchMatch handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSearchMatch_GetRawText()

const idrs_string CSearchMatch_GetRawText	(	const CSearchMatch	argCSearchMatch,
		idrs_exception *	pargException
	)

Gets the matched text as written on the page.

Returns

The matched text as written on the page

Parameters

argCSearchMatch	CSearchMatch handle
pargException	Pointer to exception structure that will be filled if an exception occurs