VMS Help System Services, $TRNLNM  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    Returns information about a logical name.

    On Alpha systems, this service accepts 64-bit addresses.

    Format

      SYS$TRNLNM  [attr] ,tabnam ,lognam ,[acmode] ,[itmlst]

    C Prototype

      int sys$trnlnm  (unsigned int *attr, void *tabnam, void

                      *lognam, unsigned char *acmode, void *itmlst);

1 - Arguments

 attr

    OpenVMS usage:mask_longword
    type:         longword (unsigned)
    access:       read only
    mechanism:    by 32- or 64-bit reference (Alpha)
    mechanism:    by 32-bit reference (VAX)
    Attributes controlling the search for the logical name. The attr
    argument is the 32-bit address (on VAX systems) or the 32- or 64-
    bit address (on Alpha systems) of a longword bit mask specifying
    these attributes.

    Each bit in the longword corresponds to an attribute and has a
    symbolic name. The $LNMDEF macro defines these symbolic names.
    To specify an attribute, use its symbolic name or set its
    corresponding bit. All undefined bits in the longword have the
    value 0.

    If you do not specify this argument or specify it as the value 0
    (no bits set), the following attribute is not used:

    Attribute        Description

    LNM$M_CASE_      If set, $TRNLNM does not distinguish between
    BLIND            uppercase and lowercase letters in the logical
                     name to be translated.
    LNM$M_           If set, $TRNLNM does not translate the current
    INTERLOCKED      logical name until any clusterwide logical
                     name modifications in progress are completed.
                     This attribute is not set by default. If
                     your application requires translation using
                     the most recent definition of a clusterwide
                     logical name, use this attribute to ensure that
                     the translation is stalled until all pending
                     modifications have been made.

 tabnam

    OpenVMS usage:logical_name
    type:         character-coded text string
    access:       read only
    mechanism:    by 32- or 64-bit descriptor-fixed-length string
                  descriptor (Alpha)
    mechanism:    by 32-bit descriptor-fixed-length string descriptor
                  (VAX)
    Name of the logical name table or the name of a searchlist
    logical name that translates the name of one or more tables
    in which to search for the specified logical name. The tabnam
    argument is the 32-bit address (on VAX systems) or the 32- or 64-
    bit address (on Alpha systems) of a descriptor pointing to this
    name. This argument is required.

    The name must be entered in uppercase letters. (This requirement
    differs from the $CRELNT system service, which automatically
    changes tabnam to uppercase.)

    If the table name is not the name of a logical name table, it is
    assumed to be a logical name and is translated iteratively until
    either the name of a logical name table is found or the number
    of translations allowed by the system have been performed. If
    the table name translates to a list of logical name tables, the
    tables are searched in the specified order.

 lognam

    OpenVMS usage:logical_name
    type:         character-coded text string
    access:       read only
    mechanism:    by 32- or 64-bit descriptor-fixed-length string
                  descriptor (Alpha)
    mechanism:    by 32-bit descriptor-fixed-length string descriptor
                  (VAX)
    Logical name about which information is to be returned. The
    lognam argument is the 32-bit address (on VAX systems) or the
    32- or 64-bit address (on Alpha systems) of a descriptor pointing
    to the logical name string. This argument is required.

 acmode

    OpenVMS usage:access_mode
    type:         byte (unsigned)
    access:       read only
    mechanism:    by 32- or 64-bit reference (Alpha)
    mechanism:    by 32-bit reference (VAX)
    Access mode to be used in the translation. The acmode argument is
    the 32-bit address (on VAX systems) or the 32- or 64-bit address
    (on Alpha systems) of a byte specifying the access mode. The
    $PSLDEF macro defines symbolic names for the four access modes.

    When you specify the acmode argument, $TRNLNM ignores all
    names (both logical names and table names) at access modes less
    privileged than the specified access mode. The specified access
    mode is not checked against that of the caller.

    If you do not specify acmode, $TRNLNM performs the translation
    without regard to access mode; however, the translation process
    proceeds from the outermost to the innermost access modes. Thus,
    if two logical names with the same name but at different access
    modes exist in the same table, $TRNLNM translates the name with
    the outermost access mode.

 itmlst

    OpenVMS usage:32-bit item_list_3 or 64-bit item_list_64b
    type:         longword (unsigned) for 32-bit; quadword (unsigned)
                  for 64-bit
    access:       read only
    mechanism:    by 32- or 64-bit reference (Alpha)
    mechanism:    by 32-bit reference (VAX)
    Item list describing the information that $TRNLNM is to return.
    The itmlst argument is the 32-bit address (on VAX systems) or
    the 32- or 64-bit address (on Alpha systems) of a list of item
    descriptors, each of which specifies or controls an item of
    information to be returned. An item list in 32-bit format is
    terminated by a longword of 0; an item list in 64-bit format is
    terminated by a quadword of 0. All items in an item list must be
    of the same format-either 32-bit or 64-bit.

    Refer to the OpenVMS System Services Reference Manual to view the
    item code diagrams and descriptor fields tables.