[next] [previous] [contents]

  UTLTOOLS DEFINE/V1

  Associates an equivalence name with a logical name. If you
  specify an existing logical name, the new equivalence name
  replaces the existing equivalence name.

  Format
  UTLTOOLS DEFINE/V1 logical-name check-ind
                                      equivalence-name[,...]

  Parameters
  logical-name

  Specifies the logical name string, which is a character string
  containing from 1 to 255 characters. The following rules
  apply:
  .
        If you specify an existing logical name, the new equiva-
        lence names replace the existing equivalence name.
  .
        If the logical name is to be entered into the process or
        system directory logical name tables (LNM$PROCESS_
        DIRECTORY, LNM$SYSTEM_DIRECTORY), then the
        name can only have from 1 to 31 alphanumeric char-
        acters, including the dollar sign ($) and underscore (_
        ).
  .
        If you specify a colon (:) at the end of a logical name, the
        UTLTOOLS DEFINE command saves the colon as part
        of the logical name. By default, the logical name is placed
        in the process logical name table.
  .
        If the string contains any characters other than upper-
        case alphanumerics, the dollar sign, or the underscore
        character, enclose the string in quotation marks (" "). Use
        two sets of quotation marks ("" "") to denote actual quo-
        tation marks. When you enclose a name in quotation
        marks, the case of alphabetic characters is preserved.

  check-ind
  Specifies whether the equivalence object (eg. directory or file)
  must exist. A value of NO indicates that the object doesn't
  need to exist. A value of YES indicates that the object must
  exist, and that an error message should be displayed if it
  doesn't. In either case, the logical name is not defined if the
  object is not found.

  The one exception to this rule is where the equivalence is a
  file, the check indicator NO is specified, the file doesn't ex-
  ist but the directory for the file does. In this case the logical
  name is defined with an equivalence of the parsed direc-
  tory and file. Thus, so long as an appropriate directory exists,
  the logical name may be used to create the file and it will be
  placed in the first appropriate directory since pasring results
  in the first found directory in a search list.

  equivalence-name
  Specifies a character string containing from 1 to 255 charac-
  ters. The following rules apply:

  .
        If the string contains any characters other than upper-
        case alphanumerics, the dollar sign, or the underscore
        character, enclose the string in quotation marks. Use
        two sets of quotation marks to denote an actual quotation
        mark. Specifying more than one equivalence name for a
        logical name creates a search list.
  .
        When you specify an equivalence name that will be used
        as a file specification, you must include the punctuation
        marks (colons, brackets, periods) that would be required
        if the equivalence name were used directly as a file spec-
        ification. Therefore, if you specify a device name as an
        equivalence name, you must terminate the equivalence
        name with a colon.

  The UTLTOOLS DEFINE command allows you to assign the
  same logical name to more than one equivalence name. For
  example, you can use the same logical name to access differ-
  ent directories on different disks or to access different files in
  different directories.

  When you specify more than one equivalence name for a log-
  ical name, you create a search list. See the OpenVMS User's
  Manual
for more information on search lists.

  Qualifiers

  The qualifiers for UTLTOOLS DEFINE/V1 are the same
  as for UTLTOOLS DEFINE with the exception of the
  /CHECK[=code] qualifier which is not supported.

  Examples
  1.

        $ UTLTOOLS DEFINE/V1 TM1 YES $DISK1:[ACCOUNTS.MEMOS]WATER.TXT
        In this example, the UTLTOOLS DEFINE/V1 command
        defines TM1 as equivalent to a file specification. The file
        must exist for the definition to succeed. An error message
        is displayed if the file is not found.