From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- docs/api_reference/C/dbstream.html | 217 +++++++++++++++++++++++++++++++++++++ 1 file changed, 217 insertions(+) create mode 100644 docs/api_reference/C/dbstream.html (limited to 'docs/api_reference/C/dbstream.html') diff --git a/docs/api_reference/C/dbstream.html b/docs/api_reference/C/dbstream.html new file mode 100644 index 00000000..b1a04776 --- /dev/null +++ b/docs/api_reference/C/dbstream.html @@ -0,0 +1,217 @@ + + + + + + DBC->db_stream() + + + + + + + + +
+
+

Library Version 12.1.6.1

+
+ + + + + + + + + +
DBC->db_stream()
Prev Chapter 13.  + Binary Large Objects +  Next
+
+
+
+
+
+
+

DBC->db_stream()

+
+
+
+ 
#include <db.h>
+
+int
+DBC->db_stream(DBC *dbc, DB_STREAM **dbs, u_int32_t flags);
+

+ The DBcursor->db_stream() method points to a + key/value pair where the data item is a binary large object + (BLOB). Use the flags parameter + to indicate whether the stream is to be opened for reading, or for + reading and writing. +

+

+ Once the stream is opened, you read it using DB_STREAM->read(), and + you write to it using DB_STREAM->write(). +

+

+ Close this stream using DB_STREAM->close(). +

+

+ If the data item is not a BLOB, this method returns an error. +

+

+ Unless otherwise specified, the + DBcursor->db_stream() + + method returns a non-zero error value on failure and 0 on success. + + + +

+
+
+
+
+

Parameters

+
+
+
+
+
+
+
+

dbs

+
+
+
+

+ The dbs + parameter references memory into which is copied the newly + opened stream. +

+
+
+
+
+
+

flags

+
+
+
+

+ The flags parameter + must be set by bitwise inclusively + OR'ing together one or more of + the following values: +

+
+
    +
  • +

    + DB_STREAM_READ +

    +

    + Indicates that the stream is to be opened for + read-only access. +

    +
    • +
  • +

    + DB_STREAM_WRITE +

    +

    + Indicates that the stream is to be opened for + read write access. The stream is sync'd to disc when + the stream is closed. +

    +
    • +
  • +

    + DB_STREAM_SYNC_WRITE +

    +

    + Indicates that the stream is to be opened for + read and write access. The stream is sync'd to disc after + each write, instead of when the stream is closed. +

    +
    • +
+
+
+
+
+
+
+
+

Errors

+
+
+
+

+ The DBcursor->db_stream() + + method may fail and return one of the following non-zero errors: + + + +

+
+
+
+
+

EINVAL

+
+
+
+

+ If the data item is not a BLOB; or if an invalid flag or + parameter is specified. +

+
+
+
+
+
+
+

Class

+
+
+
+

+ DBcursor +

+
+
+
+
+
+

See Also

+
+
+
+

+ BLOBs and Related Methods +

+
+
+
+
+ + + + + + + + + + + +
Prev  + Up +  Next
DB->set_blob_threshold()  + Home +  DB_STREAM->close()
+
+ + -- cgit v1.2.1