Functions
ESPAPICALL int32_t	esp_message_reader_is_block (const EspMessageReader reader, int is_block, EspError *error)
ESPAPICALL EspRowReader *	esp_message_reader_next_row (const EspMessageReader reader, EspError error)
ESPAPICALL EspStream *	esp_message_reader_get_stream (const EspMessageReader reader, EspError error)
ESPAPICALL int32_t	esp_messge_reader_get_numoptions (const EspMessageReader reader, int num_options, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_opcode (const EspRowReader reader, ESP_OPERATION_T opcode, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_flags (const EspRowReader reader, int32_t flags, EspError *error)
ESPAPICALL int32_t	esp_row_reader_is_null (const EspRowReader reader, const int32_t column, int is_null, EspError *error)
ESPAPICALL int32_t	esp_row_reader_is_shinethrough (const EspRowReader reader, const int32_t column, int is_shinethrough, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_integer (const EspRowReader reader, const int32_t column, int32_t int_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_long (const EspRowReader reader, const int32_t column, int64_t long_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_float (const EspRowReader reader, const int32_t column, double double_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_string (const EspRowReader reader, const int32_t column, char string_value, uint32_t buffsize, EspError error)
ESPAPICALL int32_t	esp_row_reader_get_date (const EspRowReader reader, const int32_t column, time_t date_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_timestamp (const EspRowReader reader, const int32_t column, int64_t timestamp_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_legacy_money (const EspRowReader reader, const int32_t column, EspMoney money_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_legacy_money_as_long (const EspRowReader reader, const int32_t column, int64_t long_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_money (const EspRowReader reader, const int32_t column, EspMoney money_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_money_as_long (const EspRowReader reader, const int32_t column, int64_t long_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_bigdatetime (const EspRowReader reader, const int32_t column, EspBigDatetime bigdatetime_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_binary (const EspRowReader reader, const int32_t column, void binary_value, uint32_t buffsize, EspError error)
ESPAPICALL int32_t	esp_row_reader_get_boolean (const EspRowReader reader, const int32_t column, int32_t boolean_value, EspError *error)
ESPAPICALL int32_t	esp_row_reader_get_interval (const EspRowReader reader, const int32_t column, int64_t interval_value, EspError *error)

Function Documentation

ESPAPICALL EspStream* esp_message_reader_get_stream	(	const EspMessageReader *	reader,
		EspError *	error
	)

Retrieve the EspStream for this message reader.

Returns:: EspStream, NULL on error.

ESPAPICALL int32_t esp_message_reader_is_block	(	const EspMessageReader *	reader,
		int *	is_block,
		EspError *	error
	)

Check if the data is a transaction or an envelope block.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspMessageReader to query
is_block	Pointer to contain block indication.

ESPAPICALL EspRowReader* esp_message_reader_next_row	(	const EspMessageReader *	reader,
		EspError *	error
	)

Return an EspRowReader for the next row. If there are no more rows returns NULL.

Returns:: EspRowReader.

Parameters:

reader EspMessageReader to read the next row from

ESPAPICALL int32_t esp_messge_reader_get_numoptions	(	const EspMessageReader *	reader,
		int *	num_options,
		EspError *	error
	)

Returns:: 0 on success.

ESPAPICALL int32_t esp_row_reader_get_bigdatetime	(	const EspRowReader *	reader,
		const int32_t	column,
		EspBigDatetime *	bigdatetime_value,
		EspError *	error
	)

Retrieve EspBigDatetime value at the specified column.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
bigdatetime_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_binary	(	const EspRowReader *	reader,
		const int32_t	column,
		void *	binary_value,
		uint32_t *	buffsize,
		EspError *	error
	)

Retrieve a binary value at the specified column.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
binary_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_boolean	(	const EspRowReader *	reader,
		const int32_t	column,
		int32_t *	boolean_value,
		EspError *	error
	)

Retrieve boolean value at the specified column.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
boolean_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_date	(	const EspRowReader *	reader,
		const int32_t	column,
		time_t *	date_value,
		EspError *	error
	)

Returns the date value at column 'column' if not null or shinethrough.

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
column	Column number to query
date_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_flags	(	const EspRowReader *	reader,
		int32_t *	flags,
		EspError *	error
	)

Returns:: 0 on success.

Parameters:

reader EspRowReader to query

ESPAPICALL int32_t esp_row_reader_get_float	(	const EspRowReader *	reader,
		const int32_t	column,
		double *	double_value,
		EspError *	error
	)

Retrieve a float value at the specified column.

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
column	Column number to query
double_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_integer	(	const EspRowReader *	reader,
		const int32_t	column,
		int32_t *	int_value,
		EspError *	error
	)

Retrieve an integer value at the specified column.

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
column	Column number to query
int_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_interval	(	const EspRowReader *	reader,
		const int32_t	column,
		int64_t *	interval_value,
		EspError *	error
	)

Retrieve an interval value at the specified column.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
interval_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_legacy_money	(	const EspRowReader *	reader,
		const int32_t	column,
		EspMoney *	money_value,
		EspError *	error
	)

Retrieve a legacy MONEY data value in an EspMoney object.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
money_value	Pointer to EspMoney to fill in the value

ESPAPICALL int32_t esp_row_reader_get_legacy_money_as_long	(	const EspRowReader *	reader,
		const int32_t	column,
		int64_t *	long_value,
		EspError *	error
	)

Retrieves a legacy MONEY data value at the specified column as an int64_t.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
long_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_long	(	const EspRowReader *	reader,
		const int32_t	column,
		int64_t *	long_value,
		EspError *	error
	)

Retrieve a long value at the specified column.

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
column	Column number to query
long_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_money	(	const EspRowReader *	reader,
		const int32_t	column,
		EspMoney *	money_value,
		EspError *	error
	)

Retrieve EspMoney value at the specified column.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
money_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_money_as_long	(	const EspRowReader *	reader,
		const int32_t	column,
		int64_t *	long_value,
		EspError *	error
	)

Retrieve money value as an int64_t. Avoids the creation of an EspMoney object to store the value. Potentially faster.

Returns:: 0 on success. Error details on error

Parameters:

reader	EspRowReader to query
column	Column number to query
long_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_opcode	(	const EspRowReader *	reader,
		ESP_OPERATION_T *	opcode,
		EspError *	error
	)

Get the opcode in this data row.

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
opcode	pointer to an ESP_OPERATION_T to return the opcode

ESPAPICALL int32_t esp_row_reader_get_string	(	const EspRowReader *	reader,
		const int32_t	column,
		char *	string_value,
		uint32_t *	buffsize,
		EspError *	error
	)

Return the string value at column 'column'. Expects a buffer large enough to hold the value. If it is not, the function returns an error and the required buffer size in parameter 'buffsize'

Returns:: 0 on success

Parameters:

reader	EspRowReader to query
column	Column number to query
string_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_get_timestamp	(	const EspRowReader *	reader,
		const int32_t	column,
		int64_t *	timestamp_value,
		EspError *	error
	)

Retrieve a timestamp data value at the specified column.

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
column	Column number to query
timestamp_value	Pointer in which to return the value

ESPAPICALL int32_t esp_row_reader_is_null	(	const EspRowReader *	reader,
		const int32_t	column,
		int *	is_null,
		EspError *	error
	)

Is the column null.

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
column	Column number to query

ESPAPICALL int32_t esp_row_reader_is_shinethrough	(	const EspRowReader *	reader,
		const int32_t	column,
		int *	is_shinethrough,
		EspError *	error
	)

Is the column shinethrough?

Returns:: 0 on success.

Parameters:

reader	EspRowReader to query
column	Column number to query

Functions

Function Documentation