Sybase Technical Library - Product Manuals Home
[Search Forms] [Previous Section with Hits] [Next Section with Hits] [Clear Search] Expand Search

a_validate_db structure [Table of Contents] DBTools enumeration types

[-] Chapter 3: The Database Tools Interface
[-] DBTools structures
[-] a_writefile structure


a_writefile structure


Function

Holds information needed for database write file management using the DBTools library.


Syntax

typedef struct a_writefile {
unsigned short  version;
 const char *  writename;
 const char *  wlogname;
 const char *  dbname;
 const char *  forcename;
 MSG_CALLBACK  confirmrtn;
 MSG_CALLBACK  errorrtn;
 MSG_CALLBACK  msgrtn;
 char    action;
 char    quiet   : 1;
 char    erase   : 1;
 char    force   : 1;
 char    mirrorname_present : 1;
 const char *  wlogmirrorname;
} a_writefile;


Parameters

Member

Description

version

DBTools version number.

writename

Write file name.

wlogname

Used only when creating write files.

dbname

Used when changing and creating write files.

forcename

Forced file name reference.

confirmrtn

Callback routine for confirming an action. Only used when creating a write file.

errorrtn

Callback routine for handling an error message.

msgrtn

Callback routine for handling an information message.

action

Reserved for use by Sybase.

quiet

Operate without printing messages (1), or print messages (0).

erase

Used for creating write files only. Erase without confirmation (1) or with confirmation (1).

force

If 1, force the write file to point to a named file.

mirrorname_present

Used when creating only. Set to 1. Indicates that the version of DBTools is recent enough to support the mirrorname field.

wlogmirrorname

Name of the transaction log mirror.


See Also

DBChangeWriteFile function

DBCreateWriteFile function

DBStatusWriteFile function

For more information on callback functions, see Using callback functions .


a_validate_db structure [Table of Contents] DBTools enumeration types