head 1.2; access; symbols RPM_4_2_1:1.1.1.5 RPM_4_2:1.1.1.5 RPM_4_1_1:1.1.1.5 RPM_4_1:1.1.1.4 RPM_4_0_5:1.1.1.3 RPM_4_0_4:1.1.1.2 RPM_4_0_3:1.1.1.1 RPM:1.1.1; locks; strict; comment @# @; 1.2 date 2008.01.02.09.52.58; author rse; state dead; branches; next 1.1; commitid z4cpSiAhOCXk5PLs; 1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches; next 1.1.1.2; 1.1.1.2 date 2002.01.08.00.30.08; author rse; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2003.01.18.13.48.58; author rse; state Exp; branches; next 1.1.1.4; 1.1.1.4 date 2001.07.23.20.09.13; author rse; state Exp; branches; next 1.1.1.5; 1.1.1.5 date 2003.01.18.14.04.57; author rse; state Exp; branches; next ; desc @@ 1.2 log @remove the ancient RPM 4.2.1 source tree copy @ text @ Berkeley DB: db_env_set_func_seek

db_env_set_func_seek

APIRef

#include <db.h>

int db_env_set_func_seek(int (*func_seek)(int fd, size_t pgsize, db_pgno_t pageno, u_int32_t relative, int rewind, int whence));

Description

The Berkeley DB library requires the ability to specify that a subsequent read from or write to a file will occur at a specific location in that file. The func_seek argument must conform to the following interface:

int seek(int fd, size_t pgsize, db_pgno_t pageno,
u_int32_t relative, int rewind, int whence);

The fd argument is an open file descriptor on the file.

The seek function must cause a subsequent read from or write to the file to occur at a byte offset specified by the calculation:

(pgsize * pageno) + relative

If rewind is non-zero, the byte offset is treated as a backward seek, not a forward one.

The whence argument specifies where in the file the byte offset is relative to, as described by the IEEE/ANSI Std 1003.1 (POSIX) lseek system call.

The func_seek function must return the value of errno on failure and 0 on success.

The db_env_set_func_seek interface affects the entire application, not a single database or database environment.

Although the db_env_set_func_seek interface may be used to configure Berkeley DB at any time during the life of the application, it should normally be called before making any calls to the db_env_create or db_create functions.

The db_env_set_func_seek function returns a non-zero error value on failure and 0 on success.

Errors

The db_env_set_func_seek function may fail and return a non-zero error for the following conditions:

EINVAL
An invalid flag value or parameter was specified.

The db_env_set_func_seek function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the db_env_set_func_seek function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

See Also

db_env_set_func_close, db_env_set_func_dirfree, db_env_set_func_dirlist, db_env_set_func_exists, db_env_set_func_free, db_env_set_func_fsync, db_env_set_func_ioinfo, db_env_set_func_malloc, db_env_set_func_map, db_env_set_func_open, db_env_set_func_read, db_env_set_func_realloc, db_env_set_func_seek, db_env_set_func_sleep, db_env_set_func_unlink, db_env_set_func_unmap, db_env_set_func_write, and db_env_set_func_yield.

APIRef

Copyright Sleepycat Software @ 1.1 log @Initial revision @ text @d1 1 a1 1 @ 1.1.1.1 log @Import: RPM 4.0.3 @ text @@ 1.1.1.2 log @Import: RPM 4.0.4 @ text @d1 1 a1 1 @ 1.1.1.3 log @Import: RPM 4.0.5 @ text @d1 2 a2 2 a3 1 d43 1 a43 1

The func_seek interface must return the value of errno on d45 6 a50 7

The db_env_set_func_seek method configures all operations performed by a process and all of its threads of control, not operations confined to a single database environment.

Although the db_env_set_func_seek interface may be called at any time during the life of the application, it should normally be called before making calls to the db_env_create or db_create methods.

The db_env_set_func_seek method returns a non-zero error value on failure and 0 on success. d52 1 a52 1

The db_env_set_func_seek method may fail and return a non-zero error for the following conditions: d56 4 a59 4

The db_env_set_func_seek method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the db_env_set_func_seek method may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way. d61 19 a79 1 Run-time configuration @ 1.1.1.4 log @Import: RPM 4.1 @ text @d1 2 a2 2 d4 1 d44 1 a44 1

The func_seek function must return the value of errno on d46 7 a52 6

The db_env_set_func_seek interface affects the entire application, not a single database or database environment.

Although the db_env_set_func_seek interface may be used to configure Berkeley DB at any time during the life of the application, it should normally be called before making any calls to the db_env_create or db_create functions.

The db_env_set_func_seek function returns a non-zero error value on failure and 0 on success. d54 1 a54 1

The db_env_set_func_seek function may fail and return a non-zero error for the following conditions: d58 4 a61 4

The db_env_set_func_seek function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the db_env_set_func_seek function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way. d63 1 a63 19 db_env_set_func_close, db_env_set_func_dirfree, db_env_set_func_dirlist, db_env_set_func_exists, db_env_set_func_free, db_env_set_func_fsync, db_env_set_func_ioinfo, db_env_set_func_malloc, db_env_set_func_map, db_env_set_func_open, db_env_set_func_read, db_env_set_func_realloc, db_env_set_func_seek, db_env_set_func_sleep, db_env_set_func_unlink, db_env_set_func_unmap, db_env_set_func_write, and db_env_set_func_yield. @ 1.1.1.5 log @Import: RPM 4.1.1 @ text @d1 2 a2 2 a3 1 d43 1 a43 1

The func_seek interface must return the value of errno on d45 6 a50 7

The db_env_set_func_seek method configures all operations performed by a process and all of its threads of control, not operations confined to a single database environment.

Although the db_env_set_func_seek interface may be called at any time during the life of the application, it should normally be called before making calls to the db_env_create or db_create methods.

The db_env_set_func_seek method returns a non-zero error value on failure and 0 on success. d52 1 a52 1

The db_env_set_func_seek method may fail and return a non-zero error for the following conditions: d56 4 a59 4

The db_env_set_func_seek method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the db_env_set_func_seek method may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way. d61 19 a79 1 Run-time configuration @