Arguments

 

device-name

   OpenVMS usage:char_string
   type:         character string
   access:       read only
   mechanism:    by descriptor

   Device name to be converted. The device-name argument is the
   address of a descriptor pointing to the device name. It must
   reference a disk device, and must contain 64 characters or less.
   LIB$FID_TO_NAME obtains device-name from the NAM$T_DVI field of
   an OpenVMS RMS name block.
 

file-id

   OpenVMS usage:vector_word_unsigned
   type:         word (unsigned)
   access:       read only
   mechanism:    by reference, array reference

   Specifies the file identifier. The file-id argument is the
   address of an array of three words containing the file
   identification. LIB$FID_TO_NAME obtains file-id from the NAM$W_
   FID field of an OpenVMS RMS name block. The $FIDDEF macro defines
   the structure of file-id.
 

filespec

   OpenVMS usage:char_string
   type:         character string
   access:       write only
   mechanism:    by descriptor

   Receives the file specification. The filespec argument is the
   address of a descriptor pointing to the file specification
   string. As of OpenVMS Version 7.2, the maximum file specification
   string that can be returned is 4095 bytes on Alpha and I64
   systems, and 510 bytes on VAX systems. On versions prior to
   Version 7.2, the maximum is 510 bytes on both platforms.
 

filespec-length

   OpenVMS usage:word_unsigned
   type:         word (unsigned)
   access:       write only
   mechanism:    by reference

   Receives the number of characters written into filespec,
   excluding padding in the case of a fixed-length string. The
   optional filespec-length argument is the address of an unsigned
   word containing the number of characters.

   If the output string is truncated to the number of characters
   specified in filespec, then filespec-length is set to that
   truncated size. Therefore, you can always use filespec-length
   to access a valid substring of filespec.
 

directory-id

   OpenVMS usage:vector_word_unsigned
   type:         word (unsigned)
   access:       read only
   mechanism:    by reference, array reference

   Specifies a directory file identifier. The directory-id argument
   is the address of an array of three words containing the
   directory file identifier. LIB$FID_TO_NAME obtains this array
   from the NAM$W_DID field of an OpenVMS RMS name block. The
   $FIDDEF macro defines the structure of directory-id.

   This parameter is relevant only for a structure level-1 disk
   on OpenVMS VAX systems. This parameter is ignored on OpenVMS
   Alpha and I64 systems because level-1 disks are not supported on
   OpenVMS Alpha and I64 systems.
 

acp-status

   OpenVMS usage:longword_unsigned
   type:         longword (unsigned)
   access:       write only
   mechanism:    by reference

   The status resulting from traversing the backward links. The
   optional acp-status argument is the address of an unsigned
   longword containing the status.