DEC Text Processing Utility Reference Manual
Total Page:16
File Type:pdf, Size:1020Kb
DEC Text Processing Utility Reference Manual Order Number: AA–PWCCD–TE April 2001 This manual describes the elements of the DEC Text Processing Utility (DECTPU). It is intended as a reference manual for experienced programmers. Revision/Update Information: This manual supersedes the DEC Text Processing Utility Reference Manual, Version 3.1 for OpenVMS Version 7.2. Software Version: DEC Text Processing Utility Version 3.1 for OpenVMS Alpha Version 7.3 and OpenVMS VAX Version 7.3 The content of this document has not changed since OpenVMS Version 7.1. Compaq Computer Corporation Houston, Texas © 2001 Compaq Computer Corporation COMPAQ, VAX, VMS, and the Compaq logo Registered in U.S. Patent and Trademark Office. OpenVMS is a trademark of Compaq Information Technologies Group, L.P. Motif is a trademark of The Open Group. PostScript is a registered trademark of Adobe Systems Incorporated. All other product names mentioned herein may be the trademarks or registered trademarks of their respective companies. Confidential computer software. Valid license from Compaq or authorized sublicensor required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor’s standard commercial license. Compaq shall not be liable for technical or editorial errors or omissions contained herein. The information in this document is provided "as is" without warranty of any kind and is subject to change without notice. The warranties for Compaq products are set forth in the express limited warranty statements accompanying such products. Nothing herein should be construed as constituting an additional warranty. ZK6020 The Compaq OpenVMS documentation set is available on CD-ROM. This document was prepared using DECdocument, Version 3.3-1b. Contents Preface ............................................................ xi 1 DECTPU Built-In Procedures Grouped According to Function 2 Descriptions of the DECTPU Built-In Procedures 2.1 DECTPU Built-In Procedures . ................................ 2–1 ABORT . ................................................ 2–2 ADD_KEY_MAP ............................................ 2–3 ADJUST_WINDOW . ........................................ 2–5 ANCHOR . ................................................ 2–9 ANY...................................................... 2–11 APPEND_LINE ............................................. 2–13 ARB...................................................... 2–15 ASCII ..................................................... 2–17 ATTACH .................................................. 2–19 BEGINNING_OF ............................................ 2–21 BREAK . ................................................ 2–23 CALL_USER ............................................... 2–24 CHANGE_CASE ............................................ 2–28 COMPILE . ................................................ 2–31 CONVERT . ................................................ 2–33 COPY_TEXT ............................................... 2–36 CREATE_ARRAY ............................................ 2–38 CREATE_BUFFER . ........................................ 2–41 CREATE_KEY_MAP . ........................................ 2–46 CREATE_KEY_MAP_LIST .................................... 2–48 CREATE_PROCESS . ........................................ 2–50 CREATE_RANGE . ........................................ 2–52 CREATE_WIDGET . ........................................ 2–55 CREATE_WINDOW . ........................................ 2–60 CURRENT_BUFFER . ........................................ 2–63 CURRENT_CHARACTER ..................................... 2–64 CURRENT_COLUMN ........................................ 2–66 CURRENT_DIRECTION ...................................... 2–68 CURRENT_LINE ............................................ 2–70 CURRENT_OFFSET . ........................................ 2–72 CURRENT_ROW ............................................ 2–74 CURRENT_WINDOW ........................................ 2–76 iii CURSOR_HORIZONTAL . .................................... 2–78 CURSOR_VERTICAL ........................................ 2–80 DEBUG_LINE . ............................................ 2–82 DEFINE_KEY . ............................................ 2–83 DEFINE_WIDGET_CLASS .................................... 2–87 DELETE .................................................. 2–89 EDIT . .................................................... 2–92 END_OF .................................................. 2–96 ERASE .................................................... 2–98 ERASE_CHARACTER ........................................ 2–100 ERASE_LINE . ............................................ 2–102 ERROR ................................................... 2–104 ERROR_LINE . ............................................ 2–106 ERROR_TEXT . ............................................ 2–108 EXECUTE ................................................. 2–110 EXIT . .................................................... 2–114 EXPAND_NAME ............................................ 2–115 FAO...................................................... 2–118 FILE_PARSE . ............................................ 2–120 FILE_SEARCH . ............................................ 2–124 FILL . .................................................... 2–127 GET_CLIPBOARD ........................................... 2–130 GET_DEFAULT . ............................................ 2–132 GET_GLOBAL_SELECT . .................................... 2–134 GET_INFO ................................................. 2–137 GET_INFO (any_keyname) .................................... 2–142 GET_INFO (any_keyword) . .................................... 2–144 GET_INFO (any_variable) . .................................... 2–146 GET_INFO (ARRAY) ......................................... 2–147 GET_INFO (array_variable) .................................... 2–148 GET_INFO (BUFFER) ........................................ 2–150 GET_INFO (buffer_variable) ................................... 2–151 GET_INFO (COMMAND_LINE) ................................ 2–157 GET_INFO (DEBUG) ......................................... 2–161 GET_INFO (DEFINED_KEY) .................................. 2–163 GET_INFO (integer_variable) .................................. 2–164 GET_INFO (KEY_MAP) . .................................... 2–165 GET_INFO (KEY_MAP_LIST) .................................. 2–166 GET_INFO (marker_variable) .................................. 2–167 GET_INFO (mouse_event_keyword) . ............................ 2–170 GET_INFO (PROCEDURES) ................................... 2–172 GET_INFO (PROCESS) . .................................... 2–173 GET_INFO (process_variable) .................................. 2–174 GET_INFO (range_variable) ................................... 2–175 GET_INFO (SCREEN) ........................................ 2–176 GET_INFO (string_variable) ................................... 2–187 GET_INFO (SYSTEM) ........................................ 2–189 iv GET_INFO (WIDGET) ........................................ 2–193 GET_INFO (widget_variable) . ................................ 2–198 GET_INFO (WINDOW) ....................................... 2–202 GET_INFO (window_variable) . ................................ 2–203 HELP_TEXT ............................................... 2–212 INDEX .................................................... 2–214 INT...................................................... 2–216 JOURNAL_CLOSE . ........................................ 2–218 JOURNAL_OPEN . ........................................ 2–219 KEY_NAME ................................................ 2–221 LAST_KEY . ................................................ 2–224 LEARN_ABORT ............................................. 2–225 LEARN_BEGIN and LEARN_END .............................. 2–226 LENGTH . ................................................ 2–230 LINE_BEGIN ............................................... 2–232 LINE_END ................................................ 2–233 LOCATE_MOUSE . ........................................ 2–234 LOOKUP_KEY .............................................. 2–236 LOWER_WIDGET . ........................................ 2–239 MANAGE_WIDGET . ........................................ 2–240 MAP...................................................... 2–241 MARK .................................................... 2–243 MATCH................................................... 2–246 MESSAGE . ................................................ 2–248 MESSAGE_TEXT . ........................................ 2–252 MODIFY_RANGE . ........................................ 2–255 MOVE_HORIZONTAL ........................................ 2–260 MOVE_TEXT ............................................... 2–262 MOVE_VERTICAL . ........................................ 2–265 NOTANY.................................................. 2–267 PAGE_BREAK .............................................. 2–269 POSITION . ................................................ 2–270 QUIT ..................................................... 2–274 RAISE_WIDGET ............................................ 2–276 READ_CHAR ............................................... 2–277 READ_CLIPBOARD . ........................................ 2–279 READ_FILE ................................................ 2–281 READ_GLOBAL_SELECT