CDO$HELP.HLB  —  File Area Key Properties, RMS Keyword Mapping Tables
    The following tables show the mapping of the different keywords
    used when creating a logical RMS database in a CDO dictionary.

    Table 4-1 Mapping of Keywords to Symbolic Field Offsets

    Keyword                     Symbolic Field Offset

                             Area Properties

    ALLOCATE                    XAB$L_ALQ
    ANY_CYLINDER                XAB$V_ONC
    BEST_TRY_CONTIGUOUS         XAB$V_CBT
    BUCKET_SIZE                 XAB$B_BKZ
    CONTIGUOUS                  XAB$V_CTG
    EXACT_POSITIONING           XAB$V_HRD
    EXTENSION                   XAB$W_DEQ
    POSITION                    XAB$B_ALN
    VOLUME                      XAB$W_VOL

                       File Access Block Properties

    ACCESS                      FAB$B_FAC
    BLOCK_SPAN                  FAB$V_BLK
    CARRIAGE_CONTROL            FAB$B_RAT
    CHANNEL_ACCESS_MODE         FAB$V_CHAN_MODE
    CONTROL_FIELD_SIZE          FAB$B_FSZ
    EXTENSION                   FAB$W_DEQ
    FAC                         FAB$B_FAC
    FORMAT                      FAB$B_RFM
    LOGICAL_NAME_MODE           FAB$V_LNM_MODE
    SHARING                     FAB$B_SHR
    WINDOW_SIZE                 FAB$B_RTV

                        File Definition Properties

    ALLOCATION                  FAB$L_ALQ
    BUCKET_SIZE                 FAB$B_BKS
    FILE_PROCESSING_OPTIONS     FAB$L_FOP
    FOP                         FAB$L_FOP
    GLOBAL_BUFFER_COUNT         FAB$W_GBC
    MAX_RECORD_NUMBER           FAB$L_MRN
    MAX_RECORD_SIZE             FAB$W_MRS
    MT_BLOCK_SIZE               FAB$W_BLS
    ORGANIZATION                FAB$B_ORG

                              Key Properties

    ASCENDING                   XAB$B_DTP
    CHANGES                     XAB$V_CHG
    DATA_AREA                   XAB$B_DAN
    DATA_FILL                   XAB$W_DFL
    DATA_KEY_COMPRESSION        XAB$V_KEY_NCMPR
    DATA_RECORD_COMPRESSION     XAB$V_DAT_NCMPR
    DESCENDING                  XAB$B_DTP
    DUPLICATES                  XAB$V_DUP
    INDEX_AREA                  XAB$B_IAN
    INDEX_COMPRESSION           XAB$V_IDX_NCMPR
    INDEX_FILL                  XAB$W_IFL
    LEVEL1_INDEX_AREA           XAB$B_LAN
    NODATA_KEY_COMPRESSION      XAB$V_KEY_NCMPR
    NODATA_RECORD_COMPRESSION   XAB$V_DAT_NCMPR
    NOINDEX_COMPRESSION         XAB$V_IDX_NCMPR
    NULL_KEY                    XAB$V_NUL
    NULL_VALUE                  XAB$B_NUL
    PROLOG                      XAB$B_PROLOG

    Mapping of Keywords to Symbolic Constants shows the mapping of
    keywords to symbolic constants.

    Table 4-2 Mapping of Keywords to Symbolic Constants

                       Symbolic
    Keyword            Constant       Constant Type

                               Access Mode

    EXECUTIVE          PSL$C_EXEC     FAB$V_CHAN_MODE
    NONE (default)     0              FAB$V_CHAN_MODE
    SUPER              PSL$C_SUPER    FAB$V_CHAN_MODE
    USER               PSL$C_USER     FAB$V_CHAN_MODE

                           File Access Control

    BLOCK_IO           FAB$V_BIO      FAB$B_FAC
    DELETE             FAB$V_DEL      FAB$B_FAC
    GET                FAB$V_GET      FAB$B_FAC
    PUT                FAB$V_PUT      FAB$B_FAC
    RECORD_IO          FAB$V_BRO      FAB$B_FAC
    TRUNCATE           FAB$V_TRN      FAB$B_FAC
    UPDATE             FAB$V_UPD      FAB$B_FAC

                            File Organization

    INDEXED            FAB$C_INX      FAB$B_ORG
    RELATIVE           FAB$C_REL      FAB$B_ORG
    SEQUENTIAL         FAB$C_SEQ      FAB$B_ORG
    (default)

                              Position Type

    CYLINDER           XAB$C_CYL      XAB$B_ALN
    FILE_ID            XAB$C_RFI      XAB$B_ALN
    LOGICAL            XAB$C_LBN      XAB$B_ALN
    NONE (default)     XAB$C_ANY      XAB$B_ALN
    VIRTUAL            XAB$C_VBN      XAB$B_ALN

                              Record Format

    FIXED              FAB$C_FIX      FAB$B_RFM
    STREAM             FAB$C_STM      FAB$B_RFM
    STREAM_CR          FAB$C_STMCR    FAB$B_RFM
    STREAM_LF          FAB$C_STMLF    FAB$B_RFM
    UNDEFINED          FAB$C_UDF      FAB$B_RFM
    VARIABLE           FAB$C_VAR      FAB$B_RFM
    VFC                FAB$C_VFC      FAB$B_RFM

    Mapping of Keywords to Symbolic Bit Offsets shows the mapping of
    keywords to symbolic bit offsets.

    Table 4-3 Mapping of Keywords to Symbolic Bit Offsets

                       Symbolic Bit
    Keyword            Offset         Symbolic Bit Offset Type

                         Carriage Control Options

    CARRIAGE_RETURN    FAB$V_CR       FAB$B_RAT
    (default)
    FORTRAN            FAB$V_FTN      FAB$B_RAT
    PRINT              FAB$V_PRN      FAB$B_RAT

             File Processing Options-Allocation and Extension

    BEST_TRY_          FAB$V_CBT      RMS
    CONTIGUOUS
    CONTIGUOUS         FAB$V_CTG      RMS
    TRUNCATE_ON_CLOSE  FAB$V_TEF      RMS

                   File Processing Options-Disposition

    DELETE_ON_CLOSE    FAB$V_DLT      RMS
    PRINT_ON_CLOSE     FAB$V_SPL      RMS
    SUBMIT_ON_CLOSE    FAB$V_SCF      RMS
    TEMPORARY          FAB$V_TMD      RMS
    NO_DIRECTORY_      FAB$V_TMP      RMS
    ENTRY

              File Processing Options-Name Parsing Modifiers

    CREATE_IF          FAB$V_CIF      RMS
    MAXIMIZE_VERSION   FAB$V_MXV      RMS
    SUPERSEDE          FAB$V_SUP      RMS

                  File Processing Options-Magnetic Tape

    MT_NOT_EOF         FAB$V_NEF      RMS
    MT_CURRENT_        FAB$V_POS      RMS
    POSITION
    MT_CLOSE_REWIND    FAB$V_RWC      RMS
    MT_OPEN_REWIND     FAB$V_RWO      RMS

                   File Processing Options-Nonstandard

    NON_FILE_          FAB$V_NFS      RMS
    STRUCTURED
    USER_FILE_OPEN     FAB$V_UFO      RMS

                   File Processing Options-Performance

    DEFERRED_WRITE     FAB$V_DFW      RMS
    SEQUENTIAL_ONLY    FAB$V_SQO      RMS

                   File Processing Options-Reliability

    READ_CHECK         FAB$V_RCK      RMS
    WRITE_CHECK        FAB$V_WCK      RMS

                              Share Options

    DELETE             FAB$V_SHRDEL   FAB$B_SHR
    GET                FAB$V_SHRGET   FAB$B_SHR
    MULTISTREAM        FAB$V_MSE      FAB$B_SHR
    PROHIBIT           FAB$V_NIL      FAB$B_SHR
    PUT                FAB$V_SHRPUT   FAB$B_SHR
    UPDATE             FAB$V_SHRUPD   FAB$B_SHR
    USER_INTERLOCK     FAB$V_UPI      FAB$B_SHR

    Mapping of CDO Area Properties to RMS Symbolic Field Offsets
    and Mapping of CDO Position Type Options to XAB$B_ALN Symbolic
    Constants show the mapping of area properties keywords to
    symbolic field offsets and constants.

    Table 4-4 Mapping of CDO Area Properties to RMS Symbolic Field
              Offsets

    CDO Property                RMS Symbolic Field Offset

    ALLOCATE                    XAB$L_ALQ
    ANY_CYLINDER                XAB$V_ONC
    BEST_TRY_CONTIGUOUS         XAB$V_CBT
    BUCKET_SIZE                 XAB$B_BKZ
    CONTIGUOUS                  XAB$V_CTG
    EXACT_POSITIONING           XAB$V_HRD
    EXTENSION                   XAB$W_DEQ
    POSITION                    XAB$B_ALN
    VOLUME                      XAB$W_VOL

    Table 4-5 Mapping of CDO Position Type Options to XAB$B_ALN
              Symbolic Constants

    CDO Option                  Symbolic Constant

    CYLINDER                    XAB$C_CYL
    FILE_ID                     XAB$C_RFI
    LOGICAL                     XAB$C_LBN
    NONE (default)              XAB$C_ANY
    VIRTUAL                     XAB$C_VBN

    Mapping of CDO Key Properties to RMS Symbolic Field Offsets
    shows the mapping of key properties keywords to symbolic field
    offsets.

    Table 4-6 Mapping of CDO Key Properties to RMS Symbolic Field
              Offsets

    CDO Property                RMS Symbolic Field Offset

    ASCENDING                   XAB$B_DTP
    DESCENDING                  XAB$B_DTP
    DUPLICATES                  XAB$V_DUP
    CHANGES                     XAB$V_CHG
    NULL_KEY                    XAB$V_NUL
    NULL_VALUE                  XAB$B_NUL
    DATA_AREA                   XAB$B_DAN
    DATA_FILL                   XAB$W_DFL
    DATA_KEY_COMPRESSION        XAB$V_KEY_NCMPR
    DATA_RECORD_COMPRESSION     XAB$V_DAT_NCMPR
    INDEX_AREA                  XAB$B_IAN
    INDEX_COMPRESSION           XAB$V_IDX_NCMPR
    INDEX_FILL                  XAB$W_IFL
    LEVEL1_INDEX_AREA           XAB$B_LAN
    NODATA_KEY_COMPRESSION      XAB$V_KEY_NCMPR
    NODATA_RECORD_COMPRESSION   XAB$V_DAT_NCMPR
    NOINDEX_COMPRESSION         XAB$V_IDX_NCMPR
    PROLOG                      XAB$B_PROLOG
Close Help