Lexicals

   A set of functions that return information  about  character  strings
   and attributes of the current process.


  Additional information available:

  F$CVSI     F$CVTIME   F$CVUI     F$DIRECTORY           F$EDIT     F$ELEMENT
  F$ENVIRONMENT         F$EXTRACT  F$FAO      F$FILE_ATTRIBUTES     F$GETDVI
  F$GETJPI   F$GETSYI   F$IDENTIFIER          F$INTEGER  F$LENGTH   F$LOCATE
  F$MESSAGE  F$MODE     F$PARSE    F$PID      F$PRIVILEGE           F$PROCESS
  F$SEARCH   F$SETPRV   F$STRING   F$TIME     F$TRNLNM   F$TYPE     F$USER
  F$VERIFY

LEXICALS

  F$CVSI

     Extracts bit fields from  character  string  data  and  converts  the
     result, as a signed value, to an integer.

     Format:

          F$CVSI(bit-position,width,string)


    Additional information available:

    Return_Value          bit-position          width      string
    Examples


LEXICALS

  F$CVTIME

     Converts an absolute or a combination time string to a string of  the
     form "yyyy-mm-dd hh:mm:ss.cc".  The F$CVTIME function can also return
     information about an absolute, combination, or delta time string.

     Format:

          F$CVTIME([input_time] [,output_time] [,field])


    Additional information available:

    Return_Value          input_time output_time           field
    Examples


LEXICALS

  F$CVUI

     Extracts bit fields from  character  string  data  and  converts  the
     result, as an unsigned value, to an integer.

     Format:

          F$CVUI(bit-position,width,string)


    Additional information available:

    Return_Value          bit-position          width      string     Example


LEXICALS

  F$DIRECTORY

     Returns the current default directory name string.   The  F$DIRECTORY
     function has no arguments but must be followed by parentheses.

     Format:

          F$DIRECTORY()


    Additional information available:

    Return_Value          example


LEXICALS

  F$EDIT

     Edits a string  expression  based  on  the  edits  specified  in  the
     edit-list.

     Format:

          F$EDIT(string, edit-list)


    Additional information available:

    Return_Value          string     edit-list  Examples


LEXICALS

  F$ELEMENT

     Extracts an element from a string in which the elements are separated
     by a specified delimiter.

     Format:

          F$ELEMENT(element-number, delimiter, string)


    Additional information available:

    Return_Value          element-number        delimiter  string     Example


LEXICALS

  F$ENVIRONMENT

     Obtains information on aspects of the DCL command environment.

     Format:

          F$ENVIRONMENT(item)


    Additional information available:

    Return_Value          item       Examples


LEXICALS

  F$EXTRACT

     Extracts a substring from a character string expression.

     Format:

          F$EXTRACT(offset,length,string)


    Additional information available:

    Return_Value          offset     length     string     Examples


LEXICALS

  F$FAO

     Invokes the $FAO system service  to  convert  the  specified  control
     string  to  a formatted ASCII output string.  By specifying arguments
     for FAO directives in the control  string,  you  can  use  the  F$FAO
     function to:

     o  Insert variable character string data into an output string

     o  Convert integer values into the  ASCII  representations  of  their
        decimal,  hexadecimal,  and  octal equivalents, and substitute the
        results into the output string

     Format:

          F$FAO(control-string[,arg1,arg2...arg15])


    Additional information available:

    Return_Value          control-string        arg1,arg2...arg15
    Examples


LEXICALS

  F$FILE_ATTRIBUTES

     Returns attribute information for a specified file.

     Format:

          F$FILE_ATTRIBUTES(file-spec,item)


    Additional information available:

    Return_Value          file-spec  item       Examples


LEXICALS

  F$GETDVI

     Invokes the $GETDVI system service to  return  a  specified  item  of
     information  for  a specified device.  This function allows a process
     to obtain information for a device  to  which  the  process  has  not
     necessarily assigned a channel.

     Format:

          F$GETDVI(device-name,item)


    Additional information available:

    Return_Value          device-name           item       Example


LEXICALS

  F$GETJPI

     Invokes the $GETJPI system service to return accounting, status,  and
     identification information on the specified process.  GROUP privilege
     is required to obtain information on  other  processes  in  the  same
     group.   WORLD  privilege  is  required  to obtain information on any
     other processes in the system.

     Format:

          F$GETJPI(pid,item)


    Additional information available:

    Return_Value          pid        item       Example


LEXICALS

  F$GETSYI

     Invokes  the  $GETSYI   system   service   to   return   status   and
     identification information about the local system (or about a node in
     the local VAXcluster, if your system is part of a VAXcluster).

     Format:

          F$GETSYI(item [,node])


    Additional information available:

    Return_Value          item       node       Examples


LEXICALS

  F$IDENTIFIER

     Converts an identifier in named format to its integer equivalent,  or
     vice  versa.   An  identifier  is  a name or number that identifies a
     category of users of a data resource.  The system uses identifiers to
     determine a user's access to a resource.

     Format:

          F$IDENTIFIER(identifier,conversion-type)


    Additional information available:

    Return_Value          identifier conversion-type       Examples


LEXICALS

  F$INTEGER

     Returns the  integer  equivalent  of  the  result  of  the  specified
     expression.

     Format:

          F$INTEGER(expression)


    Additional information available:

    Return_Value          expression Example


LEXICALS

  F$LENGTH

     Returns the length of a specified string.

     Format:

          F$LENGTH(string)


    Additional information available:

    Return_Value          string     Example


LEXICALS

  F$LOCATE

     Locates a character  or  character  substring  within  a  string  and
     returns  its offset within the string.  If the character or character
     substring is not found, the function returns the length of the string
     that was searched.

     Format:

          F$LOCATE(substring,string)


    Additional information available:

    Return_Value          substring  string     Examples


LEXICALS

  F$MESSAGE

     Returns a character string containing  the  message  text  associated
     with a specific system status code.

     Format:

          F$MESSAGE(status-code)


    Additional information available:

    Return_Value          status-code           Example


LEXICALS

  F$MODE

     Returns a character string showing the mode in  which  a  process  is
     executing.   The  F$MODE  function  has  no  arguments,  but  must be
     followed by parentheses.

     Format:

          F$MODE()


    Additional information available:

    Return_Value          Example


LEXICALS

  F$PARSE

     Invokes the $PARSE RMS service to  parse  a  file  specification  and
     return  either the expanded file specification or the particular file
     specification field that you request.

     Format:

     F$PARSE(file-spec[,default-spec][,related-spec][,field][,parse-type])


    Additional information available:

    Return_Value          file-spec  default-spec          related-spec
    field      parse-type Examples


LEXICALS

  F$PID

     The F$PID function returns a process identification (PID) number, and
     updates  the  context  symbol to point to the current position in the
     system's process list.

     Format:

          F$PID(context-symbol)


    Additional information available:

    Return_Value          context-symbol        Example


LEXICALS

  F$PRIVILEGE

     Returns a value of either "TRUE" or  "FALSE",  depending  on  whether
     your  current  process  privileges match the privileges listed in the
     argument.

     Format:

          F$PRIVILEGE(priv-states)


    Additional information available:

    Return_Value          priv-states           Example


LEXICALS

  F$PROCESS

     Obtains the current process name string.  The F$PROCESS function  has
     no arguments, but must be followed by parentheses.

     Format:

          F$PROCESS()


    Additional information available:

    Return_Value          Example


LEXICALS

  F$SEARCH

     Invokes the $SEARCH RMS service to search a directory file and return
     the full file specification for a file you name.

     Format:

          F$SEARCH(file-spec[,stream-id])


    Additional information available:

    Return_Value          file-spec  stream-id  Examples


LEXICALS

  F$SETPRV

     Returns a list of keywords indicating user privileges.  In  addition,
     the F$SETPRV function invokes the $SETPRV system service to enable or
     disable specified user  privileges.   The  return  string  shows  the
     status  of  user privileges before changes are made with the F$SETPRV
     function.

     In order to enable  or  disable  privileges,  your  process  must  be
     authorized  to set the specified privilege.  For detailed information
     on privilege restrictions, see the description of the $SETPRV  system
     service in the VAX/VMS System Services Reference Manual.

     Format:

          F$SETPRV(priv-states)


    Additional information available:

    Return_Value          priv-states           Examples


LEXICALS

  F$STRING

     Returns  the  string  equivalent  of  the  result  of  the  specified
     expression.

     Format:

          F$STRING(expression)


    Additional information available:

    Return_Value          expression Example


LEXICALS

  F$TIME

     Returns the current date and time string.  The F$TIME function has no
     arguments, but must be followed by parentheses.

     Format:

          F$TIME()


    Additional information available:

    Return_Value          Example


LEXICALS

  F$TRNLNM

     Translates a logical name and returns the equivalence name string, or
     the requested attributes of the logical name.  The translation is not
     iterative; the equivalence string is not checked to determine whether
     it is a logical name.

     Format:

          F$TRNLNM(logical-name [,table] [,index] [,mode] [,case] [,item])


    Additional information available:

    Return_Value          logical-name          table      index      mode
    case       item       Examples


LEXICALS

  F$TYPE

     Determines the data type of a symbol.

     Format:

          F$TYPE(symbol-name)


    Additional information available:

    Return_Value          symbol     Examples


LEXICALS

  F$USER

     Returns the current user identification code (UIC), in named  format.
     The  F$USER  function  has  no  arguments,  but  must  be followed by
     parentheses.

     Format:

          F$USER()


    Additional information available:

    Return_Value          Example


LEXICALS

  F$VERIFY

     Returns  an  integer   value   indicating   whether   the   procedure
     verification setting is currently on or off.  If used with arguments,
     the F$VERIFY function can turn the procedure and  image  verification
     settings  on  or  off.   You  must  include the parentheses after the
     F$VERIFY function, whether or not you specify arguments.

     Format:

          F$VERIFY([procedure-value] [,image-value])


    Additional information available:

    Return_Value          procedure-value       image-value
    Examples