OpenDBX/C API/odbx lo open - Revision history

Nose: moved OpenDBX/API/odbx lo open to OpenDBX/C API/odbx lo open

2009-04-28T21:15:49Z

moved OpenDBX/API/odbx lo open to OpenDBX/C API/odbx lo open

Nose: 1 revision(s)

2008-05-23T22:49:54Z

1 revision(s)

: docbook2x update

2008-05-23T22:49:54Z

docbook2x update

Nose: /* Description */

2008-05-23T22:40:24Z

‎Description

Nose: 1 revision(s)

2008-05-23T22:33:26Z

1 revision(s)

: docbook2x update

2008-05-23T22:33:26Z

docbook2x update

New page

__NOTOC__
'''Opens a large object in the database'''

#include <opendbx/api.h>

int '''odbx_lo_open'''(
odbx_result_t* '''''result''''',
odbx_lo_t** '''''lo''''',
const char* '''''value''''' )

== Description ==

Some database management systems store large amount of data in separate regions of the database and the content is only referenced by identifiers in the tables. The data types used for this are called Binary Large OBject (BLOB) and Character Large OBject (CLOB) and can be found in e.g. the Firebird and Oracle database servers. The OpenDBX library provides a large object interface to access, read and write their content via the "odbx_lo_*()" functions. To find out if large amount of data can be accessed directly or if the large object interface have to be used, [[OpenDBX/API/odbx_capabilities()|odbx_capabilities()]] provides the answer when feed with the ODBX_CAP_LO

The '''''result''''' parameter has to be the result object created and returned by [[OpenDBX/API/odbx_result|odbx_result]](). It becomes invalid after it was supplied to [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() and this function will return an error in that case. The second parameter, the pointer to a odbx_lo_t*, will contain the newly created large object handle if [[OpenDBX/API/odbx_lo_open|odbx_lo_open]]() succeeds. The '''''lo''''' handle is necessary for all other functions of the large object interface so they are able to perform their operations on the referenced content. The last parameter must be the return value of [[OpenDBX/API/odbx_field_value|odbx_field_value]]() but you have to check for NULL values before feeding the value to [[OpenDBX/API/odbx_lo_open|odbx_lo_open]](). Otherwise, an error is returned.

== Return value ==

[[OpenDBX/API/odbx_lo_open|odbx_lo_open]]() returns ODBX_ERR_SUCCESS, or 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 [[OpenDBX/API/odbx_error|odbx_error]]() and [[OpenDBX/API/odbx_error_type|odbx_error_type]]() to get further details.

== Errors ==

; -ODBX_ERR_BACKEND : The native database library couldn't open the large object
; -ODBX_ERR_NOMEM : Allocating additionally required memory failed

== See also ==

* [[OpenDBX/API/odbx_capabilities|odbx_capabilities]]()
* [[OpenDBX/API/odbx_field_value|odbx_field_value]]()
* [[OpenDBX/API/odbx_lo_close|odbx_lo_close]]()
* [[OpenDBX/API/odbx_lo_read|odbx_lo_read]]()
* [[OpenDBX/API/odbx_lo_write|odbx_lo_write]]()
* [[OpenDBX/API/odbx_result|odbx_result]]()

← Older revision	Revision as of 21:15, 28 April 2009
(No difference)

← Older revision	Revision as of 22:49, 23 May 2008
(No difference)

@@ Line 11: / Line 11: @@
 == Description ==
-Some database management systems store large amount of data in separate regions of the database and the content is only referenced by identifiers in the tables. The data types used for this are called Binary Large OBject (BLOB) and Character Large OBject (CLOB) and can be found in e.g. the Firebird and Oracle database servers. The OpenDBX library provides a large object interface to access, read and write their content via the "odbx_lo_*()" functions. To find out if large amount of data can be accessed directly or if the large object interface have to be used, [[OpenDBX/API/odbx_capabilities()|odbx_capabilities()]] provides the answer when feed with the ODBX_CAP_LO
+Some database management systems store large amount of data in separate regions of the database and the content is only referenced by identifiers in the tables. The data types used for this are called Binary Large OBject (BLOB) and Character Large OBject (CLOB) and can be found in e.g. the Firebird and Oracle database servers. The OpenDBX library provides a large object interface to access, read and write their content via the "odbx_lo_*()" functions. To find out if large amount of data can be accessed directly or if the large object interface have to be used, [[OpenDBX/API/odbx_capabilities|odbx_capabilities]]() provides the answer when feed with the ODBX_CAP_LO
 The '''''result''''' parameter has to be the result object created and returned by [[OpenDBX/API/odbx_result|odbx_result]](). It becomes invalid after it was supplied to [[OpenDBX/API/odbx_result_finish|odbx_result_finish]]() and this function will return an error in that case. The second parameter, the pointer to a odbx_lo_t*, will contain the newly created large object handle if [[OpenDBX/API/odbx_lo_open|odbx_lo_open]]() succeeds. The '''''lo''''' handle is necessary for all other functions of the large object interface so they are able to perform their operations on the referenced content. The last parameter must be the return value of [[OpenDBX/API/odbx_field_value|odbx_field_value]]() but you have to check for NULL values before feeding the value to [[OpenDBX/API/odbx_lo_open|odbx_lo_open]](). Otherwise, an error is returned.

← Older revision	Revision as of 22:33, 23 May 2008
(No difference)