compiler/include/dos/var.h

   1 #ifndef DOS_VAR_H
   2 #define DOS_VAR_H
   3
   4 /*
   5     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   6     $Id$
   7
   8     Desc: Environment variable handling.
   9     Lang: english
  10 */
  11
  12 #ifndef EXEC_NODES_H
  13 #   include <exec/nodes.h>
  14 #endif
  15
  16 /* This structure describes a local variable. The list is normally held in
  17    Process->pr_LocalVars. See <dos/dosextens.h> for more information about
  18    the list. Note that this structure is READ-ONLY! Allocate it with SetVar().
  19 */
  20 struct LocalVar {
  21     struct Node   lv_Node;  /* Standard node structure as defined in
  22                                <exec/nodes.h>. See also below. */
  23     UWORD         lv_Flags;
  24     UBYTE       * lv_Value; /* The contents of the variable. */
  25     ULONG         lv_Len;   /* The length of the contents. */
  26 };
  27
  28 /* lv_Node.ln_Type */
  29 #define LV_VAR   0 /* This is a variable. */
  30 #define LV_ALIAS 1 /* This is an alias. */
  31 /* This flag may be or'ed into lv_Node.ln_Type. It means that dos.library
  32    should ignore this entry. */
  33 #define LVB_IGNORE 7
  34 #define LVF_IGNORE (1L<<LVB_IGNORE)
  35
  36 /* The following flags are used as flags for the dos variable functions.
  37     GVB_BINARY_VAR and GVB_DONT_NULL_TERM are also saved in lv_Flags.
  38 */
  39   /* The variable is not to be used locally. */
  40 #define GVB_GLOBAL_ONLY    8
  41   /* The variable is not to be used globally. */
  42 #define GVB_LOCAL_ONLY     9
  43   /* The variable is a binary variable. lv_Value points to binary data. */
  44 #define GVB_BINARY_VAR     10
  45   /* lv_Value is not null-terminated. This is only allowed, if GVB_BINARY_VAR
  46      is also set. */
  47 #define GVB_DONT_NULL_TERM 11
  48   /* This flag tells dos to save the variable to ENVARC: too. */
  49 #define GVB_SAVE_VAR       12
  50
  51 #define GVF_GLOBAL_ONLY    (1L<<GVB_GLOBAL_ONLY)
  52 #define GVF_LOCAL_ONLY     (1L<<GVB_LOCAL_ONLY)
  53 #define GVF_BINARY_VAR     (1L<<GVB_BINARY_VAR)
  54 #define GVF_DONT_NULL_TERM (1L<<GVB_DONT_NULL_TERM)
  55 #define GVF_SAVE_VAR       (1L<<GVB_SAVE_VAR)
  56
  57 #endif /* DOS_VAR_H */