(C) 1998 AROS - The Amiga Research OS


NAME
#include <dos/var.h>
#include <proto/dos.h>

LONG DeleteVar (name , flags)

LOCATION
In DOSBase at offset 152

SYNOPSIS
STRPTR name
ULONG flags

FUNCTION
Deletes a local or environment variable.

The default is to delete a local variable if one was found, or to delete a global environmental variable otherwise.

A global environmental variable will only be deleted for the type LV_VAR.

INPUTS
name
the name of the variable to delete. Note that variable names follow the same syntax and semantics as filesystem names.

flags
A combination of the type of variable (low 8 bits), and flags to control the behaviour of this routine. Currently defined flags:

GVF_LOCAL_ONLY
delete a local variable.
GVF_GLOBAL_ONLY
delete a global environmental variable.

RESULT
If non-zero, the variable was deleted successfully, DOSFALSE otherwise.

EXAMPLE

SEE ALSO

NOTES
When the GVF_SAVE_VAR flag is set, and only one of the global variable pair could be deleted (either the in memory or on disk variable), DOSFALSE will be returned.

BUGS

INTERNALS
XXX: Find out whether GVF_SAVE_VAR does actually effect this function.

HISTORY