HP Openvms Utility Routines Manual

HP Openvms Utility Routines Manual

HP OpenVMS Utility Routines Manual Order Number: BA554-90019 June 2010 This manual describes the OpenVMS utility routines, a set of routines that provide a programming interface to various OpenVMS utilities. Revision/Update Information: This manual supersedes the HP OpenVMS Utility Routines Manual, OpenVMS Alpha Version 8.3. Software Version: OpenVMS Version 8.4 for Integrity servers OpenVMS Alpha Version 8.4 Hewlett-Packard Company Palo Alto, California © Copyright 2010 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP 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. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein. Intel and Itanium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. ZK4493 The HP OpenVMS documentation set is available on CD. This document was prepared using DECdocument, Version 3.3-1B. Contents Preface ............................................................ xvii 1 Introduction to Utility Routines 2 Access Control List (ACL) Editor Routine 2.1 Introduction to the ACL Editor Routine ........................... ACL–1 2.2 Using the ACL Editor Routine: An Example ....................... ACL–1 2.3 ACL Editor Routine . ........................................ ACL–2 ACLEDIT$EDIT ............................................ ACL–3 3 Backup (BACKUP) Routine 3.1 Introduction to the Backup API . ................................ BCK–1 3.2 Using the Backup API: An Example ............................. BCK–2 3.3 Backup API ................................................ BCK–3 BACKUP$START ............................................ BCK–4 4 Command Language Interface (CLI) Routines 4.1 Introduction to CLI Routines . ................................ CLI–1 4.2 Using the CLI Routines: An Example ............................ CLI–2 4.3 CLI Routines ............................................... CLI–4 CLI$DCL_PARSE . ........................................ CLI–5 CLI$DISPATCH ............................................. CLI–8 CLI$GET_VALUE . ........................................ CLI–9 CLI$PRESENT ............................................. CLI–12 5 Common File Qualifier Routines 5.1 Introduction to the Common File Qualifier Routines . ...............CQUAL–1 5.2 Using the Common File Qualifier Routines . .......................CQUAL–1 5.2.1 Calling UTIL$CQUAL_FILE_PARSE . .......................CQUAL–2 5.2.1.1 Specifying Times ......................................CQUAL–3 5.2.1.2 Specifying Exclude Pattern Strings . .......................CQUAL–3 5.2.2 Calling UTIL$CQUAL_FILE_MATCH . .......................CQUAL–3 5.2.2.1 Specifying Prompts ....................................CQUAL–4 5.2.2.2 Ignoring Qualifiers.....................................CQUAL–4 5.2.3 Calling UTIL$CQUAL_FILE_END ...........................CQUAL–5 5.2.4 Calling UTIL$CQUAL_CONFIRM_ACT .......................CQUAL–5 5.2.5 Creating a Command Language Definition File..................CQUAL–6 iii 5.3 UTIL$CQUAL Routines . ....................................CQUAL–10 UTIL$CQUAL_FILE_PARSE ...................................CQUAL–11 UTIL$CQUAL_FILE_MATCH ..................................CQUAL–13 UTIL$CQUAL_FILE_END . ....................................CQUAL–17 UTIL$CQUAL_CONFIRM_ACT .................................CQUAL–18 6 Convert (CONVERT) Routines 6.1 Introduction to CONVERT Routines . ............................ CONV–1 6.2 Using the CONVERT Routines: Examples ........................ CONV–2 6.3 CONVERT Routines .......................................... CONV–7 CONV$CONVERT ........................................... CONV–8 CONV$PASS_FILES .........................................CONV–12 CONV$PASS_OPTIONS . ....................................CONV–15 CONV$RECLAIM ...........................................CONV–20 7 Data Compression/Expansion (DCX) Routines 7.1 Introduction to DCX Routines .................................. DCX–1 7.1.1 Compression Routines . .................................... DCX–1 7.1.2 Expansion Routines . .................................... DCX–3 7.2 Using the DCX Routines: Examples . ............................ DCX–3 7.3 DCX Routines . ............................................ DCX–11 DCX$ANALYZE_DATA . .................................... DCX–12 DCX$ANALYZE_DONE . .................................... DCX–14 DCX$ANALYZE_INIT ........................................ DCX–15 DCX$COMPRESS_DATA . .................................... DCX–18 DCX$COMPRESS_DONE . .................................... DCX–20 DCX$COMPRESS_INIT . .................................... DCX–21 DCX$EXPAND_DATA ........................................ DCX–23 DCX$EXPAND_DONE ........................................ DCX–25 DCX$EXPAND_INIT ......................................... DCX–26 DCX$MAKE_MAP ........................................... DCX–28 8 DEC Text Processing Utility (DECTPU) Routines 8.1 Introduction to DECTPU Routines . ............................DECTPU–1 8.1.1 Interfaces to Callable DECTPU . ............................DECTPU–2 8.1.1.1 Simplified Callable Interface . ............................DECTPU–2 8.1.1.2 Full Callable Interface ..................................DECTPU–2 8.1.2 The DECTPU Shareable Image . ............................DECTPU–3 8.1.3 Passing Parameters to Callable DECTPU Routines ...............DECTPU–3 8.1.4 Error Handling ..........................................DECTPU–3 8.1.5 Return Values ...........................................DECTPU–4 8.2 Simplified Callable Interface ...................................DECTPU–4 8.3 Full Callable Interface ........................................DECTPU–5 8.3.1 Main Callable DECTPU Utility Routines .......................DECTPU–6 8.3.2 Other DECTPU Utility Routines . ............................DECTPU–6 8.3.3 User-Written Routines . ....................................DECTPU–7 8.4 Using the DECTPU Routines: Examples ..........................DECTPU–7 8.5 Creating and Calling a USER Routine ............................DECTPU–22 iv 8.5.1 The CALL_USER Code ....................................DECTPU–23 8.5.2 Linking the CALL_USER Image .............................DECTPU–25 8.6 Accessing the USER Routine from DECTPU .......................DECTPU–26 8.7 DECTPU Routines . ........................................DECTPU–27 TPU$CLEANUP ............................................DECTPU–28 TPU$CLIPARSE ............................................DECTPU–32 TPU$CLOSE_TERMINAL .....................................DECTPU–34 TPU$CONTROL ............................................DECTPU–35 TPU$EDIT . ................................................DECTPU–37 TPU$EXECUTE_COMMAND . ................................DECTPU–39 TPU$EXECUTE_INIFILE .....................................DECTPU–40 TPU$FILEIO ...............................................DECTPU–42 TPU$FILE_PARSE . ........................................DECTPU–46 TPU$FILE_SEARCH . ........................................DECTPU–49 TPU$HANDLER ............................................DECTPU–52 TPU$INITIALIZE . ........................................DECTPU–54 TPU$MESSAGE ............................................DECTPU–61 TPU$PARSEINFO . ........................................DECTPU–62 TPU$SIGNAL ..............................................DECTPU–63 TPU$SPECIFY_ASYNC_ACTION ...............................DECTPU–64 TPU$TPU . ................................................DECTPU–66 TPU$TRIGGER_ASYNC_ACTION ..............................DECTPU–67 FILEIO . ................................................DECTPU–68 FILE_PARSE ...............................................DECTPU–70 FILE_SEARCH .............................................DECTPU–72 HANDLER . ................................................DECTPU–75 INITIALIZE ................................................DECTPU–76 USER .....................................................DECTPU–77 9 DECdts Portable Applications Programming Interface 9.1 DECdts Time Representation . ................................DECdts–1 9.1.1 Absolute Time Representation ...............................DECdts–2 9.1.2 Relative Time Representation ...............................DECdts–3 9.2 Time Structures .............................................DECdts–5 9.2.1 The utc Structure . ........................................DECdts–6 9.2.2 The tm Structure . ........................................DECdts–6 9.2.3 The timespec Structure ....................................DECdts–7 9.2.4 The reltimespec Structure . ................................DECdts–7 9.2.5 The OpenVMS Time Structure ...............................DECdts–7 9.3 DECdts API Header Files .....................................DECdts–7 9.4 Linking Programs with the DECdts API . .......................DECdts–8 9.5 DECdts API Routine Functions . ................................DECdts–8 utc_abstime ................................................DECdts–13 utc_addtime ................................................DECdts–15

View Full Text

Details

  • File Type
    pdf
  • Upload Time
    -
  • Content Languages
    English
  • Upload User
    Anonymous/Not logged-in
  • File Pages
    872 Page
  • File Size
    -

Download

Channel Download Status
Express Download Enable

Copyright

We respect the copyrights and intellectual property rights of all users. All uploaded documents are either original works of the uploader or authorized works of the rightful owners.

  • Not to be reproduced or distributed without explicit permission.
  • Not used for commercial purposes outside of approved use cases.
  • Not used to infringe on the rights of the original creators.
  • If you believe any content infringes your copyright, please contact us immediately.

Support

For help with questions, suggestions, or problems, please contact us