Returns information about a DCL logical name
| Language element: |
function
|
| Category: |
general-purpose OpenVMS
|
| OpenVMS specifics: |
All aspects are
host-specific
|
|
GETLOG(logical-name,<table>,<index>,
|
- logical-name
- can be a character variable, character literal
enclosed in double quotation marks, or another character expression. This
required argument is the DCL logical name that you want information about.
- table
- is an optional character parameter that
is the name of a DCL logical name table. It can be a character variable, a
character literal enclosed in double quotation marks, or another character
expression. The default is "LNM$DCL_LOGICAL". If
the table name is more than 31 characters long, it is truncated. If table is specified, the GETLOG function searches only the specified
table for the logical name.
If you specify "CASE_SENSITIVE" in
the case argument, then you must use the proper
case in the table argument as well.
- index
- is an optional numeric parameter that indicates
the number of the translation to return if a logical name has multiple translations.
This argument can be either a numeric literal or numeric variable. The default
value is 0.
- mode
- is an optional character parameter that
contains the access mode to be used for translation. It can be a character
variable, a character literal enclosed in double quotation marks, or another
character expression. The default is "USER".
If the mode name is more than 10 characters long, it is truncated. If mode is specified, the GETLOG function searches only for a
logical name created with the specified access mode.
- case
- is an optional character parameter that
determines the case to be used for translation. It can be a character variable,
a character literal enclosed in double quotation marks, or another character
expression. If the case name is more than 14 characters long, it is truncated.
- "CASE_BLIND"
- specifies to ignore the case of the characters
for translation. This is the default.
- "CASE_SENSITIVE"
- specifies to accept the case of the characters
for translation.
If you specify "CASE_SENSITIVE" as
the value for the case argument, then you must
also use the correct case in the table argument
value.
- item
- is an optional character parameter that
specifies what type of information is to be returned about a logical name.
It can be a character variable, a character literal enclosed in double quotation
marks, or another character expression. The default value is "VALUE".
If item is more than 11 characters long, it is
truncated.
The GETLOG function
returns information about a DCL logical name. The return string is always
a character value. Numeric values are returned as character values. The default
return value is the equivalence name of a logical name.
The GETLOG function closely resembles the F$TRNLNM lexical
function of DCL. For more information about the syntax and arguments of the
GETLOG function, such as all valid values for a particular argument, refer
to the F$TRNLNM lexical function in OpenVMS DCL
Dictionary or in the SAS online Help.
Note: You cannot skip any arguments when using the GETLOG
function. For example, in order to specify a value for item, you must also specify values for table, index,
mode, and case. If you do not want to change the values for these arguments,
then simply specify the default value. ![[cautionend]](../common/images/cautend.gif)
Copyright 1999 by SAS Institute Inc., Cary, NC, USA. All rights reserved.
