CTextSearchContext_interface.h File Reference

Interface for CTextSearchContext wrapper. More...

Go to the source code of this file.

Functions
CTextSearchContext	CTextSearchContext_Create (idrs_exception *pargException)
	Creates a new instance of CTextSearchContext.
CTextSearchContext	CTextSearchContext_Create2 (const idrs_string strText, idrs_exception *pargException)
	Creates a new instance of CTextSearchContext with a pattern.
const idrs_string	CTextSearchContext_GetText (const CTextSearchContext argCTextSearchContext, idrs_exception *pargException)
	Gets the regular expression pattern.
void	CTextSearchContext_SetText (CTextSearchContext argCTextSearchContext, const idrs_string strText, idrs_exception *pargException)
	Sets the string of text to be found.
void	CTextSearchContext_Destroy (CTextSearchContext argCTextSearchContext, idrs_exception *pargException)
	Destroys a CTextSearchContext handle.

Detailed Description

Interface for CTextSearchContext wrapper.

Function Documentation

CTextSearchContext_Create()

CTextSearchContext CTextSearchContext_Create

(

idrs_exception *

pargException

)

Creates a new instance of CTextSearchContext.

Returns

The new instance of CTextSearchContext.

Parameters

pargException

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

Remarks

Instances created by this method can also be provided to CSearchContext methods

CTextSearchContext_Create2()

CTextSearchContext CTextSearchContext_Create2	(	const idrs_string	strText,
		idrs_exception *	pargException
	)

Creates a new instance of CTextSearchContext with a pattern.

Parameters

strText	The string of text to be found
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The new instance of CTextSearchContext.

Remarks

Instances created by this method can also be provided to CSearchContext methods

CTextSearchContext_Destroy()

void CTextSearchContext_Destroy	(	CTextSearchContext	argCTextSearchContext,
		idrs_exception *	pargException
	)

Destroys a CTextSearchContext handle.

Parameters

argCTextSearchContext	CTextSearchContext handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CTextSearchContext_GetText()

const idrs_string CTextSearchContext_GetText	(	const CTextSearchContext	argCTextSearchContext,
		idrs_exception *	pargException
	)

Gets the regular expression pattern.

Returns

The regular expression pattern

Parameters

argCTextSearchContext	CTextSearchContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CTextSearchContext_SetText()

void CTextSearchContext_SetText	(	CTextSearchContext	argCTextSearchContext,
		const idrs_string	strText,
		idrs_exception *	pargException
	)

Sets the string of text to be found.

Parameters

argCTextSearchContext	CTextSearchContext handle
strText	The string of text
pargException	Pointer to exception structure that will be filled if an exception occurs