DLBEGIN C-3

NAME

dlbegin - log beginning of transaction

SYNOPSIS

#include <cbase/dbase.h>

#include <cbase/logfile.h>

DLID dlbegin (comment)

char *comment;

DESCRIPTION

Dlbegin records the beginning of a transaction in a log file. The string comment is recorded in the log file along with the transaction marker. If a comment is not desired, comment should be a NULL pointer.

Transaction markers bracket a set of changes that must be done as a unit. What actually constitutes a "transaction" is defined by the calling program. If a transaction has a BEGIN marker, but not an END or CANCEL marker, it is considered incomplete. The restore program drestore(C-1) does not restore incomplete transactions.

The value returned by dlbegin is used in subsequent calls to identify the transaction.

SEE ALSO

dlcommit(C-3), dlcancel(C-3), dlend(C-3)

drestore(C-1)

DIAGNOSTICS

A value of -1 is returned if the transaction marker cannot be recorded in the log file. In this case, the RMS error message is set describing the problem.