HP OpenVMS Systems Documentation
Content starts here OpenVMS RTL General Purpose (OTS$) Manual

OpenVMS RTL General Purpose (OTS$) Manual

Order Number: AA--PV6HD--TK

April 2001

This manual documents the general-purpose routines contained in the OTS$ facility of the OpenVMS Run-Time Library.

Revision/Update Information: This manual supersedes the OpenVMS RTL General Purpose (OTS$) Manual, OpenVMS Alpha Version 7.1 and OpenVMS VAX Version 7.1.

Software Version: OpenVMS Alpha Version 7.3 OpenVMS VAX Version 7.3

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. in the United States and other countries.

All other product names mentioned herein may be trademarks of their respective companies.

Confidential computer software. Valid license from Compaq 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.

ZK5933

The Compaq OpenVMS documentation set is available on CD-ROM.

Contents Index

Preface

This manual provides users of the OpenVMS operating system with detailed usage and reference information on general-purpose routines supplied in the OTS$ facility of the Run-Time Library.

Intended Audience

This manual is intended for system and application programmers who write programs that call OTS$ Run-Time Library routines.

Document Structure

This manual is organized into two parts as follows:

  • Part I contains a brief overview of the OTS$ routines in Chapter 1.
  • Part 2, the OTS$ Reference Section, provides detailed reference information on each routine contained in the OTS$ facility of the Run-Time Library. This information is presented using the documentation format described in OpenVMS Programming Concepts Manual. Routine descriptions appear in alphabetical order by routine name.

Related Documents

The Run-Time Library routines are documented in a series of reference manuals. A description of how the Run-Time Library routines are accessed and of OpenVMS features and functionality available through calls to the OTS$ Run-Time Library appears in the OpenVMS Programming Concepts Manual. Descriptions of other RTL facilities and their corresponding routines and usages are discussed in the following books:

  • Compaq Portable Mathematics Library
  • OpenVMS VAX RTL Mathematics (MTH$) Manual
  • OpenVMS RTL DECtalk (DTK$) Manual1
  • OpenVMS RTL Library (LIB$) Manual
  • OpenVMS RTL Parallel Processing (PPL$) Manual1
  • OpenVMS RTL Screen Management (SMG$) Manual
  • OpenVMS RTL String Manipulation (STR$) Manual

The Guide to the POSIX Threads Library contains guidelines and reference information for Compaq POSIX Threads2, the Compaq Multithreading Run-Time Library.

Application programmers using any programming language can refer to the Guide to Creating OpenVMS Modular Procedures for writing modular and reentrant code.

High-level language programmers will find additional information on calling Run-Time Library routines in their language reference manual. Additional information may also be found in the language user's guide provided with your OpenVMS language software.

For a complete list and description of the manuals in the OpenVMS documentation set, see the OpenVMS Version 7.3 New Features and Documentation Overview.

For additional information about Compaq OpenVMS products and services, access the Compaq website at the following location: 


http://www.openvms.compaq.com/

Note
1 This manual has been archived but is available on the OpenVMS Documentation CD-ROM.
2 Compaq POSIX Threads was formerly called DECthreads.

Reader's Comments

Compaq welcomes your comments on this manual. Please send comments to either of the following addresses:

Internet openvmsdoc@compaq.com
Mail Compaq Computer Corporation
OSSG Documentation Group, ZKO3-4/U08
110 Spit Brook Rd.
Nashua, NH 03062-2698

How To Order Additional Documentation

Use the following World Wide Web address to order additional documentation: 


http://www.openvms.compaq.com/

If you need help deciding which documentation best meets your needs, call 800-282-6672.

Conventions

The following conventions are used in this manual:

Ctrl/ x A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.
PF1 x A sequence such as PF1 x indicates that you must first press and release the key labeled PF1 and then press and release another key or a pointing device button.
[Return] In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.)

In the HTML version of this document, this convention appears as brackets, rather than a box.

... A horizontal ellipsis in examples indicates one of the following possibilities:
  • Additional optional arguments in a statement have been omitted.
  • The preceding item or items can be repeated one or more times.
  • Additional parameters, values, or other information can be entered.
.
.
. 		A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.
( ) In command format descriptions, parentheses indicate that you must enclose choices in parentheses if you specify more than one.
[ ] In command format descriptions, brackets indicate optional choices. You can choose one or more items or no items. Do not type the brackets on the command line. However, you must include the brackets in the syntax for OpenVMS directory specifications and for a substring specification in an assignment statement.
{ } In command format descriptions, braces indicate a required choice of options; you must choose one of the options listed. Do not type the braces on the command line.
bold text This typeface represents the introduction of a new term. It also represents the name of an argument, an attribute, or a reason.
italic text Italic text indicates important information, complete titles of manuals, or variables. Variables include information that varies in system output (Internal error number), in command lines (/PRODUCER= name), and in command parameters in text (where dd represents the predefined code for the device type).
UPPERCASE TEXT Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege. 
Monospace text
Monospace type indicates code examples and interactive screen displays.

In the C programming language, monospace type in text identifies the following elements: keywords, the names of independently compiled external functions and files, syntax summaries, and references to variables or identifiers introduced in an example.

- A hyphen at the end of a command format description, command line, or code line indicates that the command or statement continues on the following line.
numbers All numbers in text are assumed to be decimal unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.

Part 1
OTS$ Overview

 This part of the OpenVMS RTL General Purpose (OTS$) Manual contains a general overview of the routines provided by the OpenVMS RTL General Purpose (OTS$) Facility, and lists them by function.

Chapter 1
Run-Time Library General Purpose (OTS$) Facility

This chapter describes the OpenVMS Run-Time Library General Purpose (OTS$) facility. See the OTS$ Reference Section for a detailed description of each routine within the OTS$ facility.

Most of the OTS$ routines were originally designed to support language compilers. Because they perform general-purpose functions, the routines were moved into the language-independent facility, OTS$.

1.1 Overview

The Run-Time Library General Purpose (OTS$) facility provides routines to perform general-purpose functions. These functions include data type conversions as part of a compiler's generated code, and some mathematical functions.

The OTS$ facility contains routines to perform the following main tasks:

  • Convert data types (see Table 1-1)
  • Divide complex and packed decimal values (see Table 1-2)
  • Move data to a specified destination address (see Table 1-3)
  • Multiply complex values (see Table 1-4)
  • Raise a base to an exponent (see Table 1-5)
  • Copy a source string to a destination string (see Table 1-6)
  • Return a string area to free storage (see Table 1-7)

Some restrictions apply if you link certain OTS$ routines on an Alpha system. See Section 1.2 for more information about these restrictions.

Table 1-1 OTS$ Conversion Routines
Routine Name Function
OTS$CNVOUT Convert a D-floating, G-floating, or H-floating value to a character string.
OTS$CVT_L_TB Convert an unsigned integer to binary text.
OTS$CVT_L_TI Convert a signed integer to signed integer text.
OTS$CVT_L_TL Convert an integer to logical text.
OTS$CVT_L_TO Convert an unsigned integer to octal text.
OTS$CVT_L_TU Convert an unsigned integer to decimal text.
OTS$CVT_L_TZ Convert an integer to hexadecimal text.
OTS$CVT_TB_L Convert binary text to an unsigned integer value.
OTS$CVT_TI_L Convert signed integer text to an integer value.
OTS$CVT_TL_L Convert logical text to an integer value.
OTS$CVT_TO_L Convert octal text to an unsigned integer value.
OTS$CVT_TU_L Convert unsigned decimal text to an integer value.
OTS$CVT_T_ x Convert numeric text to a D-, F-, G-, or H-floating value.
OTS$CVT_TZ_L Convert hexadecimal text to an unsigned integer value.

For more information on Run-Time Library conversion routines, see the CVT$ reference section in the OpenVMS RTL Library (LIB$) Manual.

Table 1-2 OTS$ Division Routines
Routine Name Function
OTS$DIVC x Perform complex division.
OTS$DIV_PK_LONG Perform packed decimal division with a long divisor.
OTS$DIV_PK_SHORT Perform packed decimal division with a short divisor.

Table 1-3 OTS$ Move Data Routines
Routine Name Function
OTS$MOVE3 Move data without fill.
OTS$MOVE5 Move data with fill.

Table 1-4 OTS$ Multiplication Routine
Routine Name Function
OTS$MULC x Perform complex multiplication.

Table 1-5 OTS$ Exponentiation Routines
Routine Name Function
OTS$POWC xC x Raise a complex base to a complex floating-point exponent.
OTS$POWC xJ Raise a complex base to a signed longword exponent.
OTS$POWDD Raise a D-floating base to a D-floating exponent.
OTS$POWDR Raise a D-floating base to an F-floating exponent.
OTS$POWDJ Raise a D-floating base to a longword integer exponent.
OTS$POWGG Raise a G-floating base to a G-floating or longword integer exponent.
OTS$POWGJ Raise a G-floating base to a longword integer exponent.
+OTS$POWHH_R3 Raise an H-floating base to an H-floating exponent.
+OTS$POWHJ_R3 Raise an H-floating base to a longword integer exponent.
OTS$POWII Raise a word integer base to a word integer exponent.
OTS$POWJJ Raise a longword integer base to a longword integer exponent.
OTS$POWLULU Raise an unsigned longword integer base to an unsigned longword integer exponent.
OTS$POW xLU Raise a floating-point base to an unsigned longword integer exponent.
OTS$POWRD Raise an F-floating base to a D-floating exponent.
OTS$POWRJ Raise an F-floating base to a longword integer exponent.
OTS$POWRR Raise an F-floating base to an F-floating exponent.
+VAX specific.

Table 1-6 OTS$ Copy Source String Routines
Routine Name Function
OTS$SCOPY_DXDX Copy a source string passed by descriptor to a destination string.
OTS$SCOPY_R_DX Copy a source string passed by reference to a destination string.

Table 1-7 OTS$ Return String Area Routines
Routine Name Function
OTS$SFREE1_DD Free one dynamic string.
OTS$SFREEN_DD Free n dynamic strings.
OTS$SGET1_DD Get one dynamic string.

1.2 Linking OTS$ Routines on an Alpha System

On Alpha systems, if you use the OTS$ entry points for certain mathematics routines, you must link against the DPML$SHR.EXE library. Alternately, you can use the equivalent math$ entry point for the routine and link against either STARLET.OBJ or the DPML$SHR.EXE library. Math$ entry points are available only on Alpha systems.

Table 1-8 lists the affected OTS$ entry points with their equivalent math$ entry points. Refer to the Compaq Portable Mathematics Library for information about the math$ entry points.

Table 1-8 OTS$ and Equivalent Math$ Entry Points
OTS$ Entry Point Math$ Entry Point
OTS$DIVC math$cdiv_f
OTS$DIVCG_R3 math$cdiv_g
OTS$MULCG_R3 math$cmul_g
OTS$POWCC math$cpow_f
OTS$POWCGCG_R3 math$cpow_g
OTS$POWCJ math$cpow_fq
OTS$POWGG math$pow_gg
OTS$POWGJ math$pow_gq
OTS$POWGLU math$pow_gq
OTS$POWII math$pow_qq
OTS$POWJJ math$pow_qq
OTS$POWLULU math$pow_qq
OTS$POWRJ math$pow_fq
OTS$POWRLU math$pow_fq
OTS$POWRR math$pow_ff

1.2.1 64-Bit Addressing Support (Alpha Only)

On Alpha systems, the General Purpose (OTS$) routines provide 64-bit virtual addressing capabilities as follows:

  • All OTS$ RTL routines accept 64-bit addresses for arguments passed by reference.
  • All OTS$ RTL routines also accept either 32-bit or 64-bit descriptors for arguments passed by descriptor.

Note
The OTS$ routines declared in ots$routines.h do not include prototypes for 64-bit data. You must provide your own generic prototypes for any OTS$ functions you use.

See the OpenVMS Programming Concepts Manual for more information about 64-bit virtual addressing capabilities.

Next Contents Index