int DB->rename(DB *db, const char *file, const char *database, const char *newname, u_int32_t flags);
The DB->rename interface renames the database specified by the file and database arguments to newname. If no database is specified, the underlying file represented by file is renamed, incidentally renaming all databases that it contained.
Applications should not rename databases that are currently in use. If an underlying file is being renamed and logging is currently enabled in the database environment, no database in the file may be open when the DB->rename function is called. In particular, some architectures do not permit renaming files with open handles. On these architectures, attempts to rename databases that are currently in use by any thread of control in the system will fail.
The flags parameter is currently unused, and must be set to 0.
After DB->rename has been called, regardless of its return, the DB handle may not be accessed again.
The DB->rename function returns a non-zero error value on failure and 0 on success.
The DB->rename function may fail and return a non-zero error for the following conditions:
The DB->rename 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->rename function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.
Copyright Sleepycat Software