GET_INFO
Provides information about the current status of the editor. Use the
first parameter to specify the general area about which you want
information. Use the second parameter (a VAXTPU string) to specify the
exact piece of information you want. Use the third parameter, in the
cases where it is required, to specify even more exactly what
information you want.
Syntax
The syntax of GET_INFO depends on the kind of information you are
trying to get. For most uses of GET_INFO, the syntax is as follows:
return_value := GET_INFO (parameter1, parameter2)
If you are using GET_INFO to get information about a defined key, a key
map, the contents of a variable while a debugger is running, the
location of a marker in a range, the variable containing a given
buffer, or the number of parameters required for a user-defined
procedure, the syntax is as follows:
return_value := GET_INFO (parameter1, parameter2, parameter3)
Parameters
parameter1 If you want GET_INFO to return information on a given
variable, use that variable as parameter1. Otherwise,
parameter1 is a keyword specifying the general subject
about which GET_INFO is to return information. The valid
keywords for parameter1 are:
o ARRAY o KEY_MAP_LIST
o BUFFER o PROCEDURES
o COMMAND_LINE o PROCESS
o DEBUG o SCREEN
o DEFINED_KEY o SYSTEM
o KEY_MAP o WINDOW
o WIDGET
parameter2 A VAXTPU string constant. This string indicates the kind
of information requested about the item in parameter1.
See Tables 4-1 and 4-2 in the VAX Text Processing Utility
Manual for a list of valid strings.
parameter3 A string or range. The appropriate GET_INFO
topics explain how to use the parameter3 in
the cases where this parameter is required. For
a list of the GET_INFO topics, see the following
section.
How to Get More Detailed HELP on GET_INFO Calls
VAXTPU contains additional HELP covering all the valid GET_INFO calls.
To see all the values of parameter2 you can use with a given value of
parameter1, invoke the topic for the appropriate value of parameter1.
For example, if you want to know what GET_INFO calls are available when
parameter1 is a marker variable, invoke the topic
GET_INFO(MARKER_VARIABLE).
Each GET_INFO topic shows the possible return values for a given
combination of parameter1 and parameter2. For example, the topic
GET_INFO(ANY_VARIABLE) shows that when you use any variable as
parameter1 and the string "type" as parameter2, GET_INFO returns a
keyword for the data type of the variable.
Note that in some topics parameter1 is a variable, while in others
parameter1 is a keyword. For example, the topic
GET_INFO(ARRAY_VARIABLE) shows what string constants can be used when
parameter1 is an array variable, while the topic GET_INFO(ARRAY) shows
what can be used when parameter1 is the keyword ARRAY.
The GET_INFO topics in VAXTPU HELP are as follows:
Topics Where Topics Where
Topics Where Parameter1 Parameter1
Parameter1 Is a Specific Is Any Keyword
Is a Variable Keyword or Keyname
------------- -------------- ---------------
GET_INFO(ANY_VARIABLE) GET_INFO(ARRAY) GET_INFO(ANY_KEYNAME)
GET_INFO(ARRAY_VARIABLE) GET_INFO(BUFFER) GET_INFO(ANY_KEYWORD)
GET_INFO(BUFFER_VARIABLE) GET_INFO(COMMAND_LINE)
GET_INFO(MARKER_VARIABLE) GET_INFO(DEBUG)
GET_INFO(PROCESS_VARIABLE) GET_INFO(DEFINED_KEY)
GET_INFO(RANGE_VARIABLE) GET_INFO(KEY_MAP)
GET_INFO(STRING_VARIABLE) GET_INFO(KEY_MAP_LIST)
GET_INFO(WIDGET_VARIABLE) GET_INFO(PROCEDURES)
GET_INFO(WINDOW_VARIABLE) GET_INFO(PROCESS)
GET_INFO(SCREEN)
GET_INFO(SYSTEM)
GET_INFO(WIDGET)
GET_INFO(WINDOW)
Examples
my_buffer := GET_INFO (BUFFERS, "current");
This assignment statement stores the pointer to the current buffer in
the variable my_buffer.
my_string := GET_INFO (my_buffer, "file_name");
This assignment statement stores the name of the input file for
my_buffer in the variable my_string.