/sys$common/syshlp/TPUHELP.HLB  —  GET_INFO(BUFFER_VARIABLE)
  GET_INFO(BUFFER_VARIABLE)

  For an overview of the GET_INFO built-in, see the HELP topic GET_INFO.

  The following strings can be used for parameter2 when parameter1 is a
  buffer variable:

  Parameter 2     | Return Value  (Parameter 1 is a buffer variable)
  ----------------+----------------------------------------------------------
  "before_bol"    |(1 or 0)  - Returns 1 if the buffer's editing
                  |            point is before the beginning of a line;
                  |            returns 0 otherwise.  The return value
                  |            has no meaning if "beyond_eob" is true.
                  |
  "beyond_eob"    |(1 or 0)  - Returns 1 if the buffer's editing point
                  |            is beyond the end of the current
                  |            buffer; returns 0 otherwise.
                  |
  "beyond_eol"    |(1 or 0)  - Returns 1 if the buffer's editing
                  |            point is beyond the end of a line;
                  |            returns 0 otherwise.  The return value
                  |            has no meaning if "beyond_eob" is true.
                  |
  "bound"         |(1 or 0)  - Returns 1 if the buffer's editing
                  |            point is at a point occupied by a character,
                  |            space, or line-end; returns 0 otherwise.
                  |
  "character"     | String   - The character at the buffer's editing point.
                  |
  "direction"     | Keyword  - FORWARD or REVERSE.
                  |
  "eob_text"      | String   - String representing the end-of-buffer text.
                  |
  "erase_         | (1 or 0) - Indicates whether the specified buffer
   unmodifiable"  |            has the ERASE_UNMODIFIABLE setting turned
                  |            on.  For more information on this setting,
                  |            set TPU HELP on SET(ERASE_UNMODIFIABLE).
                  |
  "file_name"     | String   - File name associated with the buffer when
                  |            created.
                  |
  "first_marker"  | Marker   - First marker in TPU's internal list
                  | or 0       of markers for the buffer; returns 0
                  |            if there are no markers.
                  |
  "first_range"   | Range    - First range in TPU's internal list of
                  | or 0       ranges for the buffer; returns 0 if
                  |            there are no ranges.
                  |
  "journal_file"  | String   - The name of the journal file for the
                  | or 0       specified buffer, or 0 if the buffer
                  |            is not being journaled.
                  |
  "journal_name"  | String   - The default file name TPU gives
                  |            to the buffer's journal file if
                  |            journaling is turned on and if
                  |            no other journal file name is
                  |            specified.
                  |
  "journaling"    | (1 or 0) - Returns 1 if the specified buffer is being
                  |            journaled, 0 otherwise.
                  |
  "key_map_list"  | String   - The key-map list bound to the buffer.
                  |
  "left_margin"   | Integer  - The buffer's left margin setting.
                  |
  "left_margin_   | Program  - A program variable containing the program
   action"        |  or        invoked when a character is typed to the
                  | Learn      left of the left margin.
                  |
  "line"          | String   - Line of text at buffer's editing point.
                  |
  "map_count"     | Integer  - Number of windows mapped to the buffer.
                  |
  "max_lines"     | Integer  - Maximum number of records (lines)
                  |            allowed in the buffer.
                  |
  "middle_of_tab" | (1 or 0) - Returns 1 if the editing point is in
                  |            the middle of a tab; returns 0 otherwise.
                  |            0 otherwise.   The return value
                  |            has no meaning if "beyond_eob" is true.
                  |
  "mode"          | Keyword  - INSERT or OVERSTRIKE.
                  |
  "modifiable"    | (1 or 0)   Indicates whether the buffer is modifiable.
                  |
  "modified"      | (1 or 0) - Indicates whether the buffer has been modified.
                  |
  "move_vertical_ |
   context"       | Integer  - An encoded integer specifying the column
                  |            in which TPU attempts to keep the
                  |            the cursor during MOVE_VERTICAL operations
                  |            that occur when the COLUMN_MOVE_VERTICAL
                  |            setting is turned on. Note that the return value
                  |            is an encoded value that has meaning to
                  |            TPU; it is not a simple column
                  |            number.  Use GET_INFO (buffer_variable,
                  |            "move_vertical_context") to obtain an encoded
                  |            integer to use as a parameter to
                  |            SET (MOVE_VERTICAL_CONTEXT).
                  |
  "name"          | String   - Name given buffer when created.  Uppercase
                  |            on VMS, case sensitive on ULTRIX.
                  |
  "next_marker"   | Marker   - Next marker in TPU's internal list
                  | or 0       of markers for the buffer; returns 0
                  |            if there are no markers.
                  |
  "next_range"    | Range    - Next range in TPU's internal list of
                  | or 0       ranges for the buffer; returns 0 if
                  |            there are no ranges.
                  |
  "no_write"      | (1 or 0) - Indicates whether the buffer (if modified)
                  |            should be output to a file upon exit.
                  |
  "offset"        | Integer  - Number of character positions between
                  |            the buffer's editing point and the
                  |            first character of the line containing
                  |            the editing point.  The first character
                  |            in the line has an offset of 0.  This
                  |            GET_INFO call returns 0 if the editing
                  |            point is to the left of the left margin.
                  |
  "offset_column" | Integer  - Number of screen columns between the
                  |            buffer's editing point and the beginning
                  |            of the line containing the buffer's
                  |            editing point.
                  |
  "output_file"   | String   - Name of explicitly SET output file; returns
                  | or 0       0 if no output file has been set.
                  |
  "permanent"     | (1 or 0) - Indicates whether the buffer is permanent
                  |            or if it can be deleted.
                  |
  "read_routine"  | Program    The program or learn sequence that TPU
                  |  or        executes when it owns a global selection and
                  | Learn      another DECwindows application has requested
                  |  or 0      information about that selection.  Returns
                  |            0 if no read routine exists.  When you use
                  |            this request string, use the keyword
                  |            GLOBAL_SELECT as the third parameter.
                  |
  "record_count"  | Integer  - Number of lines in the buffer.
                  |
  "record_mode"   | Keyword  - Keyword for the record format and attributes
                  |            for files written from the specified buffer.
                  |            Returns the keyword UNSPECIFIED if the record
                  |            mode will be taken from the input file (if
                  |            supported) or from the current system default.
                  |
                  |            Keyword        Record Format   Record Attributes
                  |            ------------------------------------------------
                  |            VARIABLE_NONE  fab$c_var       0
                  |            VARIABLE_FTN   fab$c_var       fab$m_ftn
                  |            VARIABLE_CR    fab$c_var       fab$m_cr
                  |            STREAM         fab$c_stm       fab$m_cr
                  |            STREAM_LF      fab$c_stmlf     fab$m_cr
                  |            STREAM_CR      fab$c_stmcr     fab$m_cr
                  |
  "record_number" | Integer  - Record number of the buffer's editing point.
                  |
  "record_size"   | Integer  - Maximum length for lines in the buffer.
                  |
  "right_margin"  | Integer  - Current right margin setting.
                  |
  "right_margin_  | Program  - A program variable containing the program
   action"        |            invoked when a character is typed outside the
                  |            right margin.
                  |
  "safe_for_      | (1 or 0) - Returns 1 if it is safe to turn on buffer
   journaling"    |            change journaling for the specified buffer;
                  |            0 otherwise.  A buffer is safe for buffer
                  |            change journaling if the buffer is empty, or
                  |            has never been modified, or has not been
                  |            modified since the last time it was written
                  |            to a file.
                  |
  "system"        | (1 or 0) - Indicates whether the buffer is a system buffer.
                  |
  "tab_stops"     | String   - Returns a string of the tab stop values
                  |   or       separated by spaces; or an integer for
                  | Integer    the number of columns between tab stops.
                  |
  "unmodifiable_  | (1 or 0) - Returns 1 if the specified buffer contains
  records"        |            one or more unmodifiable records, 0 otherwise.
  ----------------+------------------------------------------------------------
Close Help