OpenVMS Record Management Services Reference Manual

Document revision date: 15 July 2002

OpenVMS Record Management Services Reference Manual

Contents (summary)
Preface	Preface
Part 1	OpenVMS RMS---General Information
Chapter 1	Introduction to RMS
Chapter 2	RMS Program Interface
Chapter 3	Implementing RMS from C Programs
Part 2	RMS Control Blocks
Chapter 4	File Access Block (FAB)
Chapter 5	Name Block (NAM)
Chapter 6	Long Name Block (NAML)
Chapter 7	Record Access Block (RAB)
Chapter 8	64-Bit Record Access Block (RAB64)
Chapter 9	Allocation Control XAB (XABALL)
Chapter 10	Date and Time XAB (XABDAT)
Chapter 11	File Header Characteristic XAB (XABFHC)
Chapter 12	Item List XAB (XABITM)
Chapter 13	Journaling XAB (XABJNL)
Chapter 14	Key Definition XAB (XABKEY)
Chapter 15	Protection XAB (XABPRO)
Chapter 16	Revision Date and Time XAB (XABRDT)
Chapter 17	Recovery Unit XAB (XABRU)
Chapter 18	Summary XAB (XABSUM)
Chapter 19	Terminal XAB (XABTRM)
Part 3	OpenVMS RMS Services
Appendix A	RMS Control Block Macros
Appendix B	VAX MACRO Programming Information and Examples
	Index
	Figures
	Examples
	Tables

Contents

Preface

Preface Preface

Part 1

Part 1 OpenVMS RMS---General Information

Chapter 1

1 Introduction to RMS

     1.1     RMS Functions

     1.2     Passing Arguments to RMS

         1.2.1         Record Management Services and Control Blocks

         1.2.2         Control Blocks for File Services

         1.2.3         Control Blocks for Record Services

         1.2.4         Dual Purpose of Control Blocks

Chapter 2

2 RMS Program Interface

     2.1     RMS Run-Time Environment

     2.2     Conventions for Naming Fields

     2.3     RMS Calling Sequence

     2.4     Service Completion

         2.4.1         Illformed Calls to RMS

         2.4.2         Setting Synchronous or Asynchronous Option

         2.4.3         Synchronous Completion

         2.4.4         Asynchronous Completion

         2.4.5         Status Code Testing

         2.4.6         Types of Errors

     2.5     Allowable Program Execution Modes

     2.6     Access-Mode Protected Memory

     2.7     Reserved Event Flags

     2.8     DEC Multinational Character Set

Chapter 3

3 Implementing RMS from C Programs

     3.1     Creating, Accessing, and Deaccessing a File

         3.1.1         Example of Copying Records from One File to Another File

     3.2     Program to Illustrate Record Operations

     3.3     Program to Show Index Root Levels

     3.4     Program to Illustrate Using NAML Blocks (Alpha Only)

     3.5     Program to Illustrate Using the RAB64 Structure

Part 2

Part 2 RMS Control Blocks

Chapter 4

4 File Access Block (FAB)

     4.1     Summary of Fields

     4.2     FAB$B_ACMODES Field

     4.3     FAB$L_ALQ Field

     4.4     FAB$B_BID Field

     4.5     FAB$B_BKS Field

     4.6     FAB$B_BLN Field

     4.7     FAB$W_BLS Field

     4.8     FAB$V_CHAN_MODE Subfield

         4.8.1         Override Value

         4.8.2         Channel Access Mode Function

     4.9     FAB$L_CTX Field

     4.10     FAB$W_DEQ Field

     4.11     FAB$L_DEV Field

     4.12     FAB$L_DNA Field

     4.13     FAB$B_DNS Field

     4.14     FAB$B_FAC Field

     4.15     FAB$L_FNA Field

     4.16     FAB$B_FNS Field

     4.17     FAB$L_FOP Field

     4.18     FAB$B_FSZ Field

     4.19     FAB$W_GBC Field

     4.20     FAB$W_IFI Field

     4.21     FAB$B_JOURNAL Field

     4.22     FAB$V_LNM_MODE Subfield

     4.23     FAB$L_MRN Field

     4.24     FAB$W_MRS Field

     4.25     FAB$L_NAM Field

     4.26     FAB$B_ORG Field

     4.27     FAB$B_RAT Field

     4.28     FAB$B_RFM Field

     4.29     FAB$B_RTV Field

     4.30     FAB$L_SDC Field

     4.31     FAB$B_SHR Field

     4.32     FAB$L_STS Field

     4.33     FAB$L_STV Field

     4.34     FAB$L_XAB Field

Chapter 5

5 Name Block (NAM)

     5.1     Summary of Fields

     5.2     File Specification Component Descriptors

     5.3     NAM$B_BID Field

     5.4     NAM$B_BLN Field

     5.5     NAM$B_DEV and NAM$L_DEV Fields

     5.6     NAM$W_DID Field

     5.7     NAM$B_DIR and NAM$L_DIR Fields

     5.8     NAM$T_DVI Field

     5.9     NAM$L_ESA Field

     5.10     NAM$B_ESL Field

     5.11     NAM$B_ESS Field

     5.12     NAM$W_FID Field

     5.13     NAM$W_FIRST_WILD_DIR Field

     5.14     NAM$L_FNB Field

     5.15     NAM$W_LONG_DIR_LEVELS Field

     5.16     NAM$B_NAME and NAM$L_NAME Fields

     5.17     NAM$B_NMC

     5.18     NAM$B_NODE and NAM$L_NODE Fields

     5.19     NAM$B_NOP Field

     5.20     NAM$L_RLF Field

     5.21     NAM$L_RSA Field

     5.22     NAM$B_RSL Field

     5.23     NAM$B_RSS Field

     5.24     NAM$B_TYPE and NAM$L_TYPE Fields

     5.25     NAM$B_VER and NAM$L_VER Fields

     5.26     NAM$L_WCC Field

Chapter 6

6 Long Name Block (NAML)

     6.1     Using the NAM and NAML Block

     6.2     Summary of Fields

     6.3     Validating the NAML Block

     6.4     NAML$B_BID Field

     6.5     NAML$B_BLN Field

     6.6     NAML$L_FILESYS_NAME Field

     6.7     NAML$L_FILESYS_NAME_ALLOC Field

     6.8     NAML$L_FILESYS_NAME_SIZE Field

     6.9     NAML$L_INPUT_FLAGS Field

     6.10     NAML$L_LONG_DEFNAME and NAML$L_LONG_DEFNAME_SIZE Fields

     6.11     NAML$L_LONG_DEV and NAML$L_LONG_DEV_SIZE Fields

     6.12     NAML$L_LONG_DIR and NAML$L_LONG_DIR_SIZE Fields

     6.13     NAML$L_LONG_EXPAND Field

     6.14     NAML$L_LONG_EXPAND_ALLOC Field

     6.15     NAML$L_LONG_EXPAND_SIZE Field

     6.16     NAML$L_LONG_FILENAME and NAML$L_LONG_FILENAME_SIZE Fields

     6.17     NAML$L_LONG_NAME and NAML$L_LONG_NAME_SIZE Fields

     6.18     NAML$L_LONG_NODE and NAML$L_LONG_NODE_SIZE Fields

     6.19     NAML$L_LONG_RESULT Field

     6.20     NAML$L_LONG_RESULT_ALLOC Field

     6.21     NAML$L_LONG_RESULT_SIZE Field

     6.22     NAML$L_LONG_TYPE and NAML$L_LONG_TYPE_SIZE Fields

     6.23     NAML$L_LONG_VER and NAML$L_LONG_VER_SIZE Fields

     6.24     NAML$L_OUTPUT_FLAGS Field

     6.25     NAML$Q_USER_CONTEXT Field

privacy and legal statement

4523PRO_CONTENTS.HTML