$ZTRNLNM()

Examples of $ZTRNLNM()

The $ZTRNLNM function returns information about an equivalence stored in the VMS logical name tables. The $ZTRNLNM function is analogous to the DCL Lexical function F$TRNLNM. $ZTRNLNM() optionally does iterative translation, while the DCL lexical does not. This difference only manifests itself when a logical name translates to another logical name.

The format for the $ZTRNLNM function is:

    
    $ZTRNLNM(expr1[,expr2[,expr3[,expr4[,expr5[,expr6]]]]])
    
    
    

$ZTRNLNM() provides a tool for examining VMS logical names environment variables from within GT.M.

If the (third) index argument is specified in conjunction with the (sixth) item argument of "FULL", the $ZTRNLNM() uses the index value throughout the iterative translation, and terminates with a null result when it encounters no equivalence name at the specified index within each iteration.

Only the first argument is required, but missing arguments before the last argument specified, must be filled with null strings ("").

$ZTRNLNM() Item Keywords A

ITEM KEYWORD

$ZTRNLNM() DATA RETURNED

ACCESS_MODE

CONCEALED

CONFINE

FULL

Mode: 0=USER, 1=SUPER, 2=EXEC, 3=KERNEL

1 if concealed, else 0

1 if confined, else 0

Specifies that translation iterates until the result is not a logical name, or was created with the TERMINAL attribute; FULL is not available in DCL

LENGTH

MAX_INDEX

NO_ALIAS

TABLE

Length of the equivalence string

Largest index defined; 1st index is a 0

1 if no alias, else 0

1 if the equivalence is the name of a logical name table, else 0

TABLE_NAME

TERMINAL

VALUE

Name of table holding equivalence

1 if terminal, else 0

Equivalence name