API-ref-idrs16/html_c/_c_search_match__interface_8h_source.html

#ifndef CSEARCHMATCH_INTERFACE_H


#define CSEARCHMATCH_INTERFACE_H


#include "idrs_string_interface.h"

#include "ArrayInterface.h"


#include "idrs_common.h"


#ifdef __cplusplus

extern "C" {

#endif


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


IDRS_RECT CSearchMatch_GetBoundingBox(const CSearchMatch argCSearchMatch, idrs_exception *pargException);


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


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


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


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


CSearchMatchArray ArrayInterface_Create_CSearchMatchArray(idrs_exception *pargException);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* CSEARCHMATCH_INTERFACE_H */

ArrayInterface.h
Interface for TObjPtrArray wrapper.

CSearchMatch_GetBoundingBox
IDRS_RECT CSearchMatch_GetBoundingBox(const CSearchMatch argCSearchMatch, idrs_exception *pargException)
Gets the coordinates of the part on the page.

CSearchMatch_GetIdentifier
const idrs_string CSearchMatch_GetIdentifier(const CSearchMatch argCSearchMatch, idrs_exception *pargException)
Retrieves the identifier of the matched search context.

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.

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.

ArrayInterface_Create_CSearchMatchArray
CSearchMatchArray ArrayInterface_Create_CSearchMatchArray(idrs_exception *pargException)
Creates a new CSearchMatchArray object.

CSearchMatch_GetFormattedText
const idrs_string CSearchMatch_GetFormattedText(const CSearchMatch argCSearchMatch, idrs_exception *pargException)
Gets a formatted version of the matched text. Formatting includes:

CSearchMatch_GetRawText
const idrs_string CSearchMatch_GetRawText(const CSearchMatch argCSearchMatch, idrs_exception *pargException)
Gets the matched text as written on the page.

CSearchMatch
Represents a potential match for a given search.

idrs_string
Class that handles a string of characters.

idrs_common.h

idrs_string_interface.h
Interface for idrs_string wrapper.

IDRS_RECT
Structure that defines the upper-left and lower-right corners of a rectangle.
Definition idrsstd_interface.h:60