## TCPware V5.7 Programmer's Guide

- Introducing This Guide
- What You Need to Know Beforehand
- How This Guide Is Organized
- Online Help
- Obtaining Customer Support
- License Information
- Maintenance Services
- Reader's Comments Page
- Documentation Set
- Conventions Used

Preface

# Introducing This Guide

This guide describes the TCPware services and libraries from the programmer's perspective. It is for network application programmers.

# What You Need to Know Beforehand

Before using TCPware, you should be familiar with:

• Computer networks in general.

• HP’s OpenVMS operating system and file system.

# How This Guide Is Organized

This guide has the following contents:

• PART I, Introduction to Programming—Introduces network programming and the TCPware programming functions.

• PART II, UCX Compatibility Programming—Describes TCPware's support for the BGDRIVER and VAXCRTL socket routines.

• PART III, QIO Programming—Describes the TCPDRIVER, UDPDRIVER, IPDRIVER, and INETDRIVER QIO programming interfaces.

• PART IV, Programming Libraries—Describes the FTP Library, Socket Library, and TELNET Library routines.

• PART V, Application Programming Interfaces—Describes the Simple Network Management Protocol (SNMP) extendible agent application programming interface (API) routines, and the Token Authentication API functions.

• PART VI, ONC RPC Programming—Describes the Remote Procedure Call (RPC) routines.

• PART VII, Appendix—Reference for programming the Socket Library routines for versions of OpenVMS earlier than 5.3.

• Index to this guide.

# Online Help

You can use help at the DCL prompt to find the following:

• Topical help—Access TCPware help topics as follows:

$ HELP TCPWARE [topic]

The topic entry is optional. You can also enter topics and subtopics at the following prompt and its subprompts:

TCPWARE Subtopic?

Online help is also available from within certain TCPware components: FTP-OpenVMS Client and Server, Network Control Utility (NETCU), TELNET-OpenVMS Client, NSLOOKUP, and TRACEROUTE. Use the HELP command from within each component.

Example: NETCU> HELP [topic]

• Error messages help – Access help for TCPware error messages only as follows:

$ HELP TCPWARE MESSAGES

If the error message is included in the MESSAGES help, it identifies the TCPware component and provides a meaning and user action. See the Instructions under MESSAGES.

# Obtaining Customer Support

You can use the following customer support services for information and help about TCPware and other Process Software products if you subscribe to our Product Support Services. (If you bought TCPware products through an authorized TCPware reseller, contact your reseller for technical support.) Contact Technical Support directly using the following methods:

• Electronic Mail

E-mail relays your question to us quickly and allows us to respond, as soon as we have information for you. Send e-mail to support@process.com. Be sure to include your:

– Name

– Telephone number

– Company name

– Process Software product name and version number

– Operating system name and version number

Describe the problem in as much detail as possible. You should receive an immediate automated response telling you that your call was logged.

• Telephone

If calling within the continental United States or Canada, call Process Software Technical Support toll-free at 1-800-394-8700. If calling from outside the continental United States or Canada, dial 1-508-628-5074. Please be ready to provide your name, company name, and telephone number.

• World Wide Web

There is a variety of useful technical information available on our World Wide Web home page, http://www.process.com (select Customer Support).

• Internet Newsgroup

You can also access the VMSnet newsgroup, vmsnet.networks.tcp-ip.tcpware. Process Software's Engineering and Technical Support professionals monitor and respond to this open forum newsgroup on a timely basis.

# License Information

TCPware for OpenVMS includes a software license that entitles you to install and use it on one machine. Please read and understand the Software License Agreement before installing the product. If you want to use TCPware on more than one machine, you need to purchase additional licenses. Contact Process Software or your distributor for details.

# Maintenance Services

Process Software offers a variety of software maintenance and support services. Contact us or your distributor for details about these services.

# Reader's Comments Page

TCPware guides may include Reader's Comments as their last page. If you find an error in this guide or have any other comments about it, please let us know. Return a completed copy of the Reader's Comments page, or send e-mail to techpubs@process.com.

Please make your comments specific, including page references whenever possible. We would appreciate your comments about our documentation.

# Documentation Set

The documentation set for TCPware for OpenVMS consists of the following:

• Release Notes for the current version of TCPware for OpenVMS—For all users, system mangers, and application programmers. The Release Notes are available online on your TCPware for OpenVMS media and are accessible before or after software installation.

• Installation & Configuration Guide—For system managers and those installing the software. The guide provides installation and configuration instructions for the TCPware for OpenVMS products.

• User's Guide—For all users. This guide includes an introduction to TCPware for OpenVMS products as well as a reference for the user functions arranged alphabetically by product, utility, or service.

• Management Guide—For system managers. This guide contains information on functions not normally available to the general network end user. It also includes implementation notes and troubleshooting information.

• Network Control Utility (NETCU) Command Reference—For users and system managers. This reference covers all the commands available with the Network Control Utility (NETCU) and contains troubleshooting information.

• Programmer's Guide—For network application programmers. This guide gives application programmers information on the callable interfaces between TCPware for OpenVMS and application programs.

• Online help—

– Topical help, using HELP TCPWARE [topic]

– Error messages help, using HELP TCPWARE MESSAGES

# Conventions Used

Convention | Meaning
host | Any computer system on the network. The local host is your computer. A remote host is any other computer.
monospaced type | System output or user input. User input is in bold type.Example: Is this configuration correct? YES Monospaced type also indicates user input where the case of the entry should be preserved.
italic type | Variable value in commands and examples. For example, username indicates that you must substitute your actual username. Italic text also identifies documentation references.
[directory] | Directory name in an OpenVMS file specification. Include the brackets in the specification.
[optional-text] | (Italicized text and square brackets) Enclosed information is optional. Do not include the brackets when entering the information.Example: START/IP line address [info] This command indicates that the info parameter is optional.
{value | value} | Denotes that you should use only one of the given values. Do not include the braces or vertical bars when entering the value.
Note! | Information that follows is particularly noteworthy.
CAUTION! | Information that follows is critical in preventing a system interruption or security breach.
key | Press the specified key on your keyboard.
Ctrl/key | Press the control key and the other specified key simultaneously.
Return | Press the Return or Enter key on your keyboard.