Preface

The OpenVOS C Subroutines Manual (R068) documents the operating system subroutines. It explains what each subroutine does and shows how to call each subroutine from an OpenVOS Standard C program.

This manual does not describe all OpenVOS subroutines. See Appendix B for a list of all other OpenVOS subroutines and where they are documented.

This manual is intended for systems and application programmers developing applications using the operating system subroutine interface.

Before using this subroutines manual, you should be familiar with the OpenVOS Standard C Reference Manual 

Manual Version

This manual is a revision. For information on which release of the software this manual documents, see the Notice page.

Change bars, which appear in the margin, note the specific changes to text since the previous publication of this manual.

The following subroutine descriptions have been updated to reflect new or modified functionality or to correct mistakes in the previous revision of the manual (with changes marked with change bars).

s$copy_file
s$get_module_usage
s$create_index2
s$set_ram_file
s$expand_posix_path
s$start_logging
s$get_module_info
 

In addition to the preceding changes, this revision corrects some documentation errors.

Manual Organization

The manual has three chapters and two appendixes.

Chapter 1 gives general information about using the subroutines. You will find the general information you need to use the operating system service subroutines in an OpenVOS Standard C program. The chapter includes a list of the data types of the subroutine arguments, the conventions and rules that govern the declarations of the subroutine parameters, and the method for calling the subroutines from programs written in OpenVOS Standard C.

Chapter 2 classifies all of the subroutines into functional categories and describes the purpose of each subroutine.

Chapter 3 is a reference guide to the subroutines, explaining each subroutine in detail. The subroutines are presented in alphabetical order.

Appendix A contains a table of the OpenVOS internal character code set.

Appendix B lists all of the subroutines that are not described in this manual. It also indicates where you can find a description of each.

Related Manuals

See the following Stratus manuals for related documentation.

  • Introduction to VOS 
  • VOS Reference Manual 
  • OpenVOS Commands Reference Manual 
  • OpenVOS Standard C Reference Manual 
  • OpenVOS C Transaction Processing Facility Reference Manual 
  • VOS Transaction Processing Facility Guide 
  • OpenVOS System Administration: Administering and Customizing a System 
  • OpenVOS System Administration: Registration and Security 
  • OpenVOS System Administration: Disk and Tape Administration 
  • VOS System Administration: Administering the Spooler Facility 
  • OpenVOS System Administration: Configuring a System 
  • Using OpenVOS Extended Names 

Notation Conventions

This manual uses the following notation conventions.

  • Italics introduces or defines new terms. For example:

The master disk is the name of the member disk from which the module was booted.

  • Boldface emphasizes words in text. For example:

Every module must have a copy of the module_start_up.cm file.

  • Monospace represents text that would appear on your terminal's screen (such as commands, subroutines, code fragments, and names of files and directories). For example:
change_current_dir (master_disk)>system>doc
  • Monospace italic represents terms that are to be replaced by literal values. In the following example, the user must replace the monospace-italic term with a literal value.
list_users -module module_name
  • Monospace bold represents user input in examples and figures that contain both user input and system output (which appears in monospace). For example:
display_access_list system_default

%dev#m1>system>acl>system_default

w  *.*

Format for Subroutines

Stratus manuals use the following format conventions for documenting subroutines. Note that the subroutine descriptions do not necessarily include each of the following sections.

subroutine_name
The name of the subroutine is at the top of the first page of the subroutine description.

Purpose
Explains briefly what the subroutine does.

Usage
Shows how to declare the variables passed as arguments to the subroutine, declare the subroutine entry in a program, and call the subroutine.

Arguments
Describes the subroutine arguments.

Explanation
Provides information about how to use the subroutine.

Error Codes
Explains some error codes that the subroutine can return.

Examples
Illustrates uses of the subroutine or provides sample input to and output from the subroutine.

Related Information
Refers you to other subroutines and commands similar to or useful with this subroutine.

Getting Help

If you have a technical question about ftServer system hardware or software, try these online resources first:

  • Online documentation at the StrataDOC Web site. Stratus provides complimentary access to StrataDOC, an online-documentation service that enables you to view, search, download, and print customer documentation. You can access StrataDOC at the following Web site:

http://stratadoc.stratus.com

  • Online support from Stratus Customer Service. You can find the latest technical information about an ftServer system through online product support at the Customer Support Web site:

http://www.stratus.com/go/support

If you are unable to resolve your questions with the help available at these online sites, and the ftServer system is covered by a service agreement, please contact the Stratus Customer Assistance Center (CAC) or your authorized Stratus service representative. For information about how to contact the CAC, see the following Web site:

http://www.stratus.com/go/support/ftserver/location

Commenting on This Manual

You can comment on this manual using one of the following methods. When you submit a comment, be sure to provide the manual's name and part number, a description of the problem, and the location in the manual where the affected text appears.

  • From StrataDOC, click the site feedback link at the bottom of any page. In the pop-up window, answer the questions and click Submit.
  • From any email client, send email to comments@stratus.com.
  • From the ASM web site, log on to your ASM account and create a new issue.

Stratus welcomes any corrections and suggestions for improving this manual.