CNumberSearchContext_interface.h File Reference

Interface for CNumberSearchContext wrapper. More...

Go to the source code of this file.

Functions
CNumberSearchContext	CNumberSearchContext_Create (idrs_exception *pargException)
	Creates a new instance of CNumberSearchContext.
void	CNumberSearchContext_SetMinimumDecimalDigits (CNumberSearchContext argCNumberSearchContext, IDRS_UINT const uiMinDecimals, idrs_exception *pargException)
	Set the minimum number of decimals.
IDRS_UINT	CNumberSearchContext_GetMininumDecimalDigits (const CNumberSearchContext argCNumberSearchContext, idrs_exception *pargException)
	Get the minimum number of decimals.
void	CNumberSearchContext_SetMaximumDecimalDigits (CNumberSearchContext argCNumberSearchContext, IDRS_UINT const uiMaxDecimals, idrs_exception *pargException)
	Set the maximum number of decimals.
IDRS_UINT	CNumberSearchContext_GetMaximumDecimalDigits (const CNumberSearchContext argCNumberSearchContext, idrs_exception *pargException)
	Get the maximum number of decimals.
void	CNumberSearchContext_SetMinimumValue (CNumberSearchContext argCNumberSearchContext, double const dMinValue, idrs_exception *pargException)
	Set the minimum value to search for.
double	CNumberSearchContext_GetMinimumValue (const CNumberSearchContext argCNumberSearchContext, idrs_exception *pargException)
	Get the minimum value to search for.
void	CNumberSearchContext_SetMaximumValue (CNumberSearchContext argCNumberSearchContext, double const dMaxValue, idrs_exception *pargException)
	Set the maximum value to search for.
double	CNumberSearchContext_GetMaximumValue (const CNumberSearchContext argCNumberSearchContext, idrs_exception *pargException)
	Get the maximum value to search for.
void	CNumberSearchContext_SetDecimalSeparator (CNumberSearchContext argCNumberSearchContext, IDRS_WCHAR32 const cDecimalSeparator, idrs_exception *pargException)
	Set the decimal separator.
IDRS_WCHAR32	CNumberSearchContext_GetDecimalSeparator (const CNumberSearchContext argCNumberSearchContext, idrs_exception *pargException)
	Get the decimal separator.
void	CNumberSearchContext_Destroy (CNumberSearchContext argCNumberSearchContext, idrs_exception *pargException)
	Destroys a CNumberSearchContext handle.

Detailed Description

Interface for CNumberSearchContext wrapper.

Function Documentation

CNumberSearchContext_Create()

CNumberSearchContext CNumberSearchContext_Create

(

idrs_exception *

pargException

)

Creates a new instance of CNumberSearchContext.

Returns

The new instance of CNumberSearchContext.

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

CNumberSearchContext_Destroy()

void CNumberSearchContext_Destroy	(	CNumberSearchContext	argCNumberSearchContext,
		idrs_exception *	pargException
	)

Destroys a CNumberSearchContext handle.

Parameters

argCNumberSearchContext	CNumberSearchContext handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_GetDecimalSeparator()

IDRS_WCHAR32 CNumberSearchContext_GetDecimalSeparator	(	const CNumberSearchContext	argCNumberSearchContext,
		idrs_exception *	pargException
	)

Get the decimal separator.

Returns

The decimal separator (char)

Parameters

argCNumberSearchContext	CNumberSearchContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_GetMaximumDecimalDigits()

IDRS_UINT CNumberSearchContext_GetMaximumDecimalDigits	(	const CNumberSearchContext	argCNumberSearchContext,
		idrs_exception *	pargException
	)

Get the maximum number of decimals.

Returns

The maximum number of decimals (unsigned int)

Parameters

argCNumberSearchContext	CNumberSearchContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_GetMaximumValue()

double CNumberSearchContext_GetMaximumValue	(	const CNumberSearchContext	argCNumberSearchContext,
		idrs_exception *	pargException
	)

Get the maximum value to search for.

Returns

The maximum value to search for (double)

Parameters

argCNumberSearchContext	CNumberSearchContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_GetMinimumValue()

double CNumberSearchContext_GetMinimumValue	(	const CNumberSearchContext	argCNumberSearchContext,
		idrs_exception *	pargException
	)

Get the minimum value to search for.

Returns

The minimum value to search for (double)

Parameters

argCNumberSearchContext	CNumberSearchContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_GetMininumDecimalDigits()

IDRS_UINT CNumberSearchContext_GetMininumDecimalDigits	(	const CNumberSearchContext	argCNumberSearchContext,
		idrs_exception *	pargException
	)

Get the minimum number of decimals.

Returns

The minimum number of decimals (unsigned int)

Parameters

argCNumberSearchContext	CNumberSearchContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_SetDecimalSeparator()

void CNumberSearchContext_SetDecimalSeparator	(	CNumberSearchContext	argCNumberSearchContext,
		IDRS_WCHAR32 const	cDecimalSeparator,
		idrs_exception *	pargException
	)

Set the decimal separator.

Parameters

argCNumberSearchContext	CNumberSearchContext handle
cDecimalSeparator	Decimal separator
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_SetMaximumDecimalDigits()

void CNumberSearchContext_SetMaximumDecimalDigits	(	CNumberSearchContext	argCNumberSearchContext,
		IDRS_UINT const	uiMaxDecimals,
		idrs_exception *	pargException
	)

Set the maximum number of decimals.

Parameters

argCNumberSearchContext	CNumberSearchContext handle
uiMaxDecimals	Maximum number of decimals
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_SetMaximumValue()

void CNumberSearchContext_SetMaximumValue	(	CNumberSearchContext	argCNumberSearchContext,
		double const	dMaxValue,
		idrs_exception *	pargException
	)

Set the maximum value to search for.

Parameters

argCNumberSearchContext	CNumberSearchContext handle
dMaxValue	Maximum value to search for
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_SetMinimumDecimalDigits()

void CNumberSearchContext_SetMinimumDecimalDigits	(	CNumberSearchContext	argCNumberSearchContext,
		IDRS_UINT const	uiMinDecimals,
		idrs_exception *	pargException
	)

Set the minimum number of decimals.

Parameters

argCNumberSearchContext	CNumberSearchContext handle
uiMinDecimals	Minimum number of decimals
pargException	Pointer to exception structure that will be filled if an exception occurs

CNumberSearchContext_SetMinimumValue()

void CNumberSearchContext_SetMinimumValue	(	CNumberSearchContext	argCNumberSearchContext,
		double const	dMinValue,
		idrs_exception *	pargException
	)

Set the minimum value to search for.

Parameters

argCNumberSearchContext	CNumberSearchContext handle
dMinValue	Minimum value to search for
pargException	Pointer to exception structure that will be filled if an exception occurs