Get an element from an array field referenced by an iterator

Functions
LBMSDMExpDLL int	lbmsdm_iter_get_boolean_elem (lbmsdm_iter_t *Iterator, size_t Element, uint8_t *Value)
	Fetch an array field element value from the field referenced by an iterator. More...
LBMSDMExpDLL int	lbmsdm_iter_get_int8_elem (lbmsdm_iter_t *Iterator, size_t Element, int8_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_uint8_elem (lbmsdm_iter_t *Iterator, size_t Element, uint8_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_int16_elem (lbmsdm_iter_t *Iterator, size_t Element, int16_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_uint16_elem (lbmsdm_iter_t *Iterator, size_t Element, uint16_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_int32_elem (lbmsdm_iter_t *Iterator, size_t Element, int32_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_uint32_elem (lbmsdm_iter_t *Iterator, size_t Element, uint32_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_int64_elem (lbmsdm_iter_t *Iterator, size_t Element, int64_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_uint64_elem (lbmsdm_iter_t *Iterator, size_t Element, uint64_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_float_elem (lbmsdm_iter_t *Iterator, size_t Element, float *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_double_elem (lbmsdm_iter_t *Iterator, size_t Element, double *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_decimal_elem (lbmsdm_iter_t *Iterator, size_t Element, lbmsdm_decimal_t *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_timestamp_elem (lbmsdm_iter_t *Iterator, size_t Element, struct timeval *Value)
LBMSDMExpDLL int	lbmsdm_iter_get_message_elem (lbmsdm_iter_t *Iterator, size_t Element, lbmsdm_msg_t **Value)
LBMSDMExpDLL int	lbmsdm_iter_get_string_elem (lbmsdm_iter_t *Iterator, size_t Element, char *Value, size_t *Size)
	Fetch a string array field element value from the field referenced by an iterator. More...
LBMSDMExpDLL int	lbmsdm_iter_get_unicode_elem (lbmsdm_iter_t *Iterator, size_t Element, wchar_t *Value, size_t *Size)
	Fetch a unicode array field element value from the field referenced by an iterator. More...
LBMSDMExpDLL int	lbmsdm_iter_get_blob_elem (lbmsdm_iter_t *Iterator, size_t Element, void *Value, size_t *Size)
	Fetch a blob array field element value from the field referenced by an iterator. More...

Detailed Description

The functions in this group allow the retrieval of an element value of an array field, referenced by an iterator.

Function Documentation

LBMSDMExpDLL int lbmsdm_iter_get_blob_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		void *	Value,
		size_t *	Size
	)

Fetch a blob array field element value from the field referenced by an iterator.

Parameters

Iterator	The SDM iterator to use.
Element	Element number (zero-based).
Value	Pointer to variable where the value is stored.
Size	Pointer to a variable containing the maximum size of Value in bytes. On exit, it will contain the actual size of the data.

Return values

LBMSDM_SUCCESS	if successful
LBMSDM_INSUFFICIENT_BUFFER_LENGTH	if Size is not large enough for the data. Size will contain the length required in bytes.
LBMSDM_FAILURE	otherwise.

LBMSDMExpDLL int lbmsdm_iter_get_boolean_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		uint8_t *	Value
	)

Fetch an array field element value from the field referenced by an iterator.

Parameters

Iterator	The SDM iterator to use.
Element	Element number (zero-based).
Value	Pointer to variable where the value is stored.

Returns

LBMSDM_SUCCESS if successful, LBMSDM_FAILURE otherwise.

LBMSDMExpDLL int lbmsdm_iter_get_decimal_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		lbmsdm_decimal_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_double_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		double *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_float_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		float *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_int16_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		int16_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_int32_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		int32_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_int64_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		int64_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_int8_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		int8_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_message_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		lbmsdm_msg_t **	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_string_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		char *	Value,
		size_t *	Size
	)

Fetch a string array field element value from the field referenced by an iterator.

Parameters

Iterator	The SDM iterator to use.
Element	Element number (zero-based).
Value	Pointer to variable where the value is stored.
Size	Pointer to a variable containing the maximum size of Value (including the terminating null character). On exit, it will contain the actual size of the string (including the terminating null character).

Return values

LBMSDM_SUCCESS	if successful
LBMSDM_INSUFFICIENT_BUFFER_LENGTH	if Size is not large enough for the string. Size will contain the length required.
LBMSDM_FAILURE	otherwise.

LBMSDMExpDLL int lbmsdm_iter_get_timestamp_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		struct timeval *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_uint16_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		uint16_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_uint32_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		uint32_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_uint64_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		uint64_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_uint8_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		uint8_t *	Value
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

LBMSDMExpDLL int lbmsdm_iter_get_unicode_elem	(	lbmsdm_iter_t *	Iterator,
		size_t	Element,
		wchar_t *	Value,
		size_t *	Size
	)

Fetch a unicode array field element value from the field referenced by an iterator.

Parameters

Iterator	The SDM iterator to use.
Element	Element number (zero-based).
Value	Pointer to variable where the value is stored.
Size	Pointer to a variable containing the maximum size of Value in wchar_ts. On exit, it will contain the actual size of the data.

Return values

LBMSDM_SUCCESS	if successful
LBMSDM_INSUFFICIENT_BUFFER_LENGTH	if Size is not large enough for the data. Size will contain the length required in wchar_ts.
LBMSDM_FAILURE	otherwise.