odbx_result(3)

NAME
odbx_result - Retrieves a result set from the database server

SYNOPSIS
\FC#include <opendbx/api.h>\F[]

\FCint odbx_result\F[]
\FC(odbx_t* handle, odbx_result_t** result, struct timeval* timeout, unsigned long chunk);\F[]

DESCRIPTION
Retrieves the result of a query statement sent by \FCodbx_query\F[]() from the database server. After a statement was successfully executed, a dynamically allocated object representing the result set is stored in \FCresult\F[] which must be freed afterwards by \FCodbx_result_finish\F[](). Result sets for SELECT-like statements returned successfully by this function can be processed by calling \FCodbx_row_fetch\F[]() until all rows are retrieved. If the statement was an INSERT, UPDATE, DELETE or a similar statement, the number of affected rows is available via \FCodbx_rows_affected\F[]().

If a timeout or error occurs, the \FCresult\F[] pointer is set to NULL. In case of a timeout, \FCodbx_result\F[]() should be called again because the query isn't canceled. This function must be called multiple times until it returns zero, even if the query contains only one statement. Otherwise, memory will be leaked and \FCodbx_query\F[]() will return an error.

The third parameter (\FCtimeout\F[]) restricts the time the function is waiting for a result form the server. It may be NULL to wait until a result arrives. Otherwise, it can contain any number of seconds and microseconds in a timeval structure to wait for. The timeval structure must be set each time before calling \FCodbx_result\F[]() because its content may get changed by the function. If the server doesn't respond within the timeout, the query isn't canceled! Instead, the next call to this function will wait for the same result set. Waiting the specified time may be implemented in the backends if it is possible, but there is no guarantee. If not, \FCodbx_result\F[]() will return not before a responds arrives.

Dependent on the native database library, it may be possible to retrieve all rows at once (if \FCchunk\F[] is zero), one by one or more than one row at once. All positive values including zero are allowed as values for \FCchunk\F[] If paging (more than one row at once) is not supported by the backend, it will use "one by one" or "all at once" if this is the only option provided.

RETURN VALUE
\FCodbx_result\F[]() returns \FCODBX_RES_ROWS\F[] ("3") if a result set is available and zero if no more results will be returned for the last query string sent via \FCodbx_query\F[]() successfully. \FCODBX_RES_NOROWS\F[] ("2") is returned if the statement was executed successfully but will not return a results set (like for INSERT, UPDATE and DELETE statements) and \FCODBX_RES_TIMEOUT\F[] ("1") indicates a timeout. As soon as \FCODBX_RES_DONE\F[] ("0") is returned, the available result sets were processed. The named constants are available since OpenDBX 1.3.2 and the numbers in brackets have to be used instead if a previous release is is the basis for the application development.

It returns an error code whose value is less than zero if one of the operations couldn't be completed successfully. Possible error codes are listed in the error section and they can be feed to \FCodbx_error\F[]() and \FCodbx_error_type\F[]() to get further details. In this case, the backends are responsible for freeing the data structures they allocated inside the function and to clear the errornous result set if there's one available. The backends will also set the given result pointer to NULL before returning the error. Nevertheless, if a non-fatal error occurred it's possible to retrieve further result sets and this is necessary before calling \FCodbx_query\F[]() on the same connection again.

ERRORS

-\FCODBX_ERR_BACKEND\F[]
    The native database library returned an error

-\FCODBX_ERR_PARAM\F[]
    Either \FChandle\F[] or \FCresult\F[] are NULL or \FChandle\F[] is invalid

-\FCODBX_ERR_NOMEM\F[]
    Allocating the required memory for the result failed

-\FCODBX_ERR_RESULT\F[]
    Waiting for a response from the server failed because the connection was lost

SEE ALSO
\FCodbx_column_count\F[](), \FCodbx_column_name\F[](), \FCodbx_column_type\F[](), \FCodbx_rows_affected\F[](), \FCodbx_row_fetch\F[](), \FCodbx_result_finish\F[]()