gate_data_statement_t Interface Reference

An object that covers a data request statement. More...

#include <adapter.h>

Inheritance diagram for gate_data_statement_t:

Public Member Functions
gate_result_t	get_param_count (gate_size_t *ptr_count)
	Returns the amount of parameters in statement.
gate_result_t	set_param (gate_size_t index, gate_value_t const *value)
	Sets a statement parameter value addressed by index.
gate_result_t	set_named_param (gate_string_t const *name, gate_value_t const *value)
	Sets a statement parameter value addressed by name.
gate_result_t	reset (void)
	Resets the statement object to be reused for a new query setup.
gate_result_t	execute (gate_int32_t *affected_rows)
	Executes a prepared DB statement and returns the amount of affected data rows.
gate_result_t	query (gate_data_reader_t **ptr_reader)
	Executes a prepared DB query and returns a reader interface to fetch and access data.
Public Member Functions inherited from gate_object_t
char const *	get_interface_name ()
	Returns on object's interface path name.
void	release ()
	Decrease object's reference counter, releases the object when count reaches zero.
int	retain ()
	Increase object's reference counter.

Detailed Description

An object that covers a data request statement.

Member Function Documentation

get_param_count()

gate_result_t get_param_count

(

gate_size_t *

ptr_count

)

Returns the amount of parameters in statement.

Parameters

[out]

ptr_count

Pointer to size-value to be initialized with amount of parameter fields

Returns

GATE_RESULT_* result code

set_param()

gate_result_t set_param	(	gate_size_t	index,
		gate_value_t const *	value )

Sets a statement parameter value addressed by index.

Parameters

[in]	index	Parameter index in be updated
[in]	value	New value for parameter to be set in statement

Returns

GATE_RESULT_* result code

set_named_param()

gate_result_t set_named_param	(	gate_string_t const *	name,
		gate_value_t const *	value )

Sets a statement parameter value addressed by name.

Parameters

[in]	name	Name of parameter to be updated
[in]	value	New value for parameter to be set in statement

Returns

GATE_RESULT_* result code

reset()

gate_result_t reset

(

void

)

Resets the statement object to be reused for a new query setup.

Returns

GATE_RESULT_* result code

execute()

gate_result_t execute

(

gate_int32_t *

affected_rows

)

Executes a prepared DB statement and returns the amount of affected data rows.

Parameters

[out]

affected_rows

Pointer to integer to be initialized with the amount of records changed by the statement

Returns

GATE_RESULT_* result code

query()

gate_result_t query

(

gate_data_reader_t **

ptr_reader

)

Executes a prepared DB query and returns a reader interface to fetch and access data.

Parameters

[out]

ptr_reader

Pointer to object-pointer to be initialized with new created reader interface

Returns

GATE_RESULT_* result code

---

The documentation for this interface was generated from the following file:

• src/gate/data/adapter.h