"RLMXXX Select"

Class members to support SELECT functionality. More...

Functions
quint8	RLMXXXCRC::SelectAddRecord (const srecord &SRecord, quint8 &ec)
	Function add a SELECT definition to the module. More...
quint8	RLMXXXCRC::SelectDeleteRecordByIndex (const quint8 sindex, quint8 &ec)
	Function to remove a SELECT definition record from the module. More...
quint8	RLMXXXCRC::SelectRecordByIndex (const quint8 sindex, const quint8 snum, quint8 &ec)
	Function to select a SELECT definition record from the module using the srecord index and select number to retrieve it with the function SelectGetRecord. More...
quint8	RLMXXXCRC::SelectGetRecord (srecord &SRecord, quint8 &ec)
	Function retrieve a SELECT definition from module. More...
quint8	RLMXXXCRC::SelectExecuteByIndex (const quint8 sindex, const quint8 snum, quint8 &ec)
	Function to activate a SELECT definition on the module. More...

Detailed Description

Class members to support SELECT functionality.

Some text here..

Function Documentation

SelectAddRecord()

quint8 RLMXXXCRC::SelectAddRecord	(	const srecord &	SRecord,
		quint8 &	ec
	)

Function add a SELECT definition to the module.

Its called by application. If the call failed an error code will be provided from module.

See also

InventoryByIndex()

struct srecord {}

Parameters

[in]	SRecord	structure with filter values
[out]	ec	Error Code returned from the module if command failed

Returns

1 on success, 0 if failed

SelectDeleteRecordByIndex()

quint8 RLMXXXCRC::SelectDeleteRecordByIndex	(	const quint8	sindex,
		quint8 &	ec
	)

Function to remove a SELECT definition record from the module.

Its called by application.
If the call failed an error code will be provided from module.

See also

InventoryByIndex()

struct srecord {}

Parameters

[in]	sindex	index of a srecord to be removed
[out]	ec	Error Code returned from the module if command failed

Returns

1 on success, 0 if failed

SelectExecuteByIndex()

quint8 RLMXXXCRC::SelectExecuteByIndex	(	const quint8	sindex,
		const quint8	snum,
		quint8 &	ec
	)

Function to activate a SELECT definition on the module.

Its called by application.
If the call failed an error code will be provided from module.

See also

struct srecord {}

Parameters

[in]	sindex	index of a srecord
[in]	snum	number of selection
[out]	ec	Error Code returned from the module if command failed

Returns

1 on success, 0 if failed

SelectGetRecord()

quint8 RLMXXXCRC::SelectGetRecord	(	srecord &	SRecord,
		quint8 &	ec
	)

Function retrieve a SELECT definition from module.

Before the application needs to call the function RmuSelectRecordByIndex.
Its called by application. If the call failed an error code will be provided from module.

See also

SelectRecordByIndex()

struct srecord {}

Parameters

[out]	SRecord	Struct with srecord data
[out]	ec	Error Code returned from the module if command failed

Returns

1 on success, 0 if failed

SelectRecordByIndex()

quint8 RLMXXXCRC::SelectRecordByIndex	(	const quint8	sindex,
		const quint8	snum,
		quint8 &	ec
	)

Function to select a SELECT definition record from the module using the srecord index and select number to retrieve it with the function SelectGetRecord.

Its called by application. If the call failed an error code will be provided from module.

See also

SelectGetRecord()

struct srecord {}

Parameters

[in]	sindex	index of a srecord
[in]	snum	number of selection
[out]	ec	Error Code returned from the module if command failed

Returns

1 on success, 0 if failed