CSearchResult_interface.h File Reference

Interface for CSearchResult wrapper. More...

Go to the source code of this file.

Functions
const idrs_string	CSearchResult_GetIdentifier (const CSearchResult argCSearchResult, idrs_exception *pargException)
	Retrieves the identifier of the matched search context.
const CSearchMatchArray	CSearchResult_GetMatches (const CSearchResult argCSearchResult, idrs_exception *pargException)
	gets the Match elements of this Result
CSearchResultArray	ArrayInterface_Create_CSearchResultArray (idrs_exception *pargException)
	Creates a new CSearchResultArray object.

Detailed Description

Interface for CSearchResult wrapper.

Function Documentation

ArrayInterface_Create_CSearchResultArray()

CSearchResultArray ArrayInterface_Create_CSearchResultArray

(

idrs_exception *

pargException

)

Creates a new CSearchResultArray object.

Parameters

pargException

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

Returns

The newly created CSearchResultArray

CSearchResult_GetIdentifier()

const idrs_string CSearchResult_GetIdentifier	(	const CSearchResult	argCSearchResult,
		idrs_exception *	pargException
	)

Retrieves the identifier of the matched search context.

Returns

The identifier associated with the search context.

Parameters

argCSearchResult	CSearchResult handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSearchResult_GetMatches()

const CSearchMatchArray CSearchResult_GetMatches	(	const CSearchResult	argCSearchResult,
		idrs_exception *	pargException
	)

gets the Match elements of this Result

Returns

the array of matches

Parameters

argCSearchResult	CSearchResult handle
pargException	Pointer to exception structure that will be filled if an exception occurs