contents.gifprev1.gifnext1.gif

GET_INFO (BUFFER_VARIABLE)

This form requires two parameters. The first is a buffer variable. The second is any of several words. The list below shows the items which can be used as the second parameter.

Parameter 2 Return

"before_bol" Returns 1 or 0; 1 if to left of left margin.

"beyond_eob" Returns 1 or 0; 1 if past end of buffer.

"beyond_eol" Returns 1 or 0; 1 if past end of line.

"bound" Returns 1 or 0; 1 if no free cursor movement.

“bol_text” Return the text to be displayed before the beginning of every line.

"character" The character at the current editing position in the named buffer returned as a string.

"direction" The current editing direction of the named buffer.

"eob_text" The end-of-buffer text for the named buffer.

"erase_unmodifiable" Returns 1 or 0; 1 if built-ins can only remove flagged buffers.

"file_name" The name of the file read during the CREATE_BUFFER process for the named buffer.

"first_marker" The first marker in the named buffer's marker list or 0 if no such marker exists.

"first_range" The first range in the named buffer's range list or 0 if no such range exists.

"journaling" Returns 1 or 0; 1 if key activity in this buffer is being journaled.

"key_map_list" The key-map-list bound to the named buffer.

"left_margin" The left margin setting of the named buffer.

"left_margin_action" The action taken when inserting text to the left of the left margin setting.

"line" The current line in the named buffer.

“line_style” Line terminator style. Returns keyword DOS or UNIX, or 0.

"map_count" Number of windows mapped to the named buffer.

"max_lines" Returns maximum number of lines a buffer can maintain or -1 if no limit.

"middle_of_tab" Returns 1 or 0; 1 if cursor is positioned in the middle of a tab.

"mode" Returns either INSERT or OVERSTRIKE.

"modifiable" Returns a non-zero value if the named buffer can be modified.

"modified" Returns a non-zero value if the named buffer has been modified.

"name" The name of the buffer passed as parameter 1. This is useful if parameter 1 is a built-in which returns the name of a buffer.

"next_marker" The next marker in the named buffer's marker list or 0 if no such marker exists.

"next_range" The next range in the named buffer's range list or 0 if no such range exists.

"no_write" Returns a non-zero value if the named buffer has been modified and should be written at exit time.

"offset" The number of characters between the left margin and current editing position in the named buffer.

"offset_column" The screen column of the current editing position in the named buffer.

"output_file" The name of the file written by the named buffer at exit time.

"permanent" Returns a non-zero value if the named buffer cannot be deleted.

"read_routine" Returns program used to give other applications the global selection or 0 if unspecified. This form requires a third parameter, the keyword GLOBAL_SELECT, to work, and is only used in a windowed environment.

"record_count" The number of lines in the named buffer.

"record_number" Editing position's record number identified.

"record_size" The maximum line length in the named buffer.

"right_margin" The right margin setting of the named buffer.

"right_margin_action" The action taken when inserting text to the right of the right margin setting in the named buffer.

"safe_for_journaling" Returns 1 or 0; 1 if buffer can now safely journal.

"system" Returns a non-zero value if the named buffer is a system buffer.

"tab_stops" An integer or string of tab stop value(s) for the named buffer.

"unmodifiable_records" Returns 1 or 0; 1 if the buffer contains any unmodifiable records.

Syntax:

value := GET_INFO ( buffer, request )

Example:

The following example uses the nu/TPU built-in CURRENT_BUFFER to pass the name of the current buffer to GET_INFO and "name" as the second parameter. The result is the name of the current buffer at the current edit position.

COPY_TEXT (GET_INFO (CURRENT_BUFFER, "name"));