DLCLEAR C-3

NAME

dlclear - log clearing of logical RMSfile

SYNOPSIS

#include <cbase/dbase.h>

#include <cbase/logfile.h>

dlclear (lname)

char *lname;

DESCRIPTION

Dlclear records a marker in the current log file to clear an RMSfile. When the restore program, drestore(C-1), encounters this marker, it clears the named logical RMSfile.

Lname is the name of the logical RMSfile. It can have any of the following formats:

dbase~lfile

~lfile

lfile

The first form names an explicit database, the latter two use the default database. A default database is defined by calling dbopen(C-3), or setting the environment variable DBASE to a valid database name.

If a path name (a name containing slashes (\ or /)) is passed to dlclear, no entry is made in the log file.

SEE ALSO

dlconv(C-3), dldelete(C-3), dlexpand(C-3), dlmake(C-3),

drestore(C-1), clearlf(C-1)

DIAGNOSTICS

A value of FAILED (0) is returned if the marker cannot be written in the log file. The RMS error message is set describing the error.

NOTES

This function is intended for internal use only. Indiscriminate use of this function can render log files useless.