HELP CONVERT — VMS 5.5
The CONVERT commands perform the following functions:
o Copy records from one file to another, changing the organization
and format of the input file to that of the output file (see
File).
o Converts a revisable format file to another revisable or final
form file from the DCL command line. (see /DOCUMENT).
o Make empty buckets in Prologue 3 indexed files available so that
new records can be written in them (see /RECLAIM).
Additional information available:
File
Invokes the VMS Convert Utility (CONVERT) to copy records from one
file to another, changing the organization and format of the input
file to those of the output file. For a complete description of the
of the VMS Convert Utility, including more information about the
CONVERT command and its qualifiers, see the VMS Convert and
Convert/Reclaim Utility Manual.
Format:
CONVERT input-file-spec[,...] output-file-spec
Additional information available:
ParametersCommand QualifiersExamples
Parameters
input-file-spec[,...] Specifies the name of one or more files to be converted. If you specify more than one file, separate them with commas. You may specify up to 10 input files. Multiple input files are concatenated into a single output file. No wildcard characters are allowed in the file specification. output-file-spec Specifies the name of the output file into which the converted records are to be written. If you omit the file type, the file type of the first input file is assumed. No wildcard characters are allowed in the file specification.
Command Qualifiers
Additional information available:
/APPEND/CREATE/EXCEPTIONS_FILE/EXIT/FAST_LOAD
/FDL/FILL_BUCKETS/FIXED_CONTROL/KEY/MERGE
/PAD/PROLOG/READ_CHECK/SHARE/SORT
/APPEND
/APPEND /NOAPPEND Controls whether the output records are appended to an existing sequential file. If both /APPEND and /CREATE are specified, /APPEND overrides the /CREATE qualifier. The default is /NOAPPEND. This qualifier is ignored when the output file's organization is relative or indexed.
/CREATE
/CREATE /NOCREATE Controls whether CONVERT creates an output file or uses an existing file for output. If the output file is to have different characteristics from the input file, you must also specify the /FDL qualifier. To create a file with the same characteristics as the input file, omit the /FDL qualifier. By default, /CREATE is assumed.
/EXCEPTIONS_FILE
/EXCEPTIONS_FILE[=file-spec] /NOEXCEPTIONS_FILE Controls whether an exceptions record file is generated during the conversion. An exceptions file is a sequential file that contains a copy of any input records that cause an exception. These records are not written to the output file because of a format error. If you omit the file specification, the records are written to the current SYS$OUTPUT device. By default, no exception record file is produced.
/EXIT
/EXIT /NOEXIT Controls whether the Convert Utility exits when an exception record is encountered. If you specify /NOEXIT or omit the qualifier, the operation will continue processing records even though an exception record was encountered.
/FAST_LOAD
/FAST_LOAD /NOFAST_LOAD Controls whether a fast-loading algorithm is used for indexed files. The loading algorithm requires multiple scratch disk files. By default, a fast-loading algorithm is used.
/FDL
/FDL=file-spec Specifies the FDL file to use in creating the output file. The newly created output file will have the same name specified by the output file specification. This name overrides the name specified in the FDL file. The default file type for the FDL file is FDL.
/FILL_BUCKETS
/FILL_BUCKETS /NOFILL_BUCKETS Controls whether to override the bucket fill percentage parameter associated with the output file, and to direct CONVERT to fill the buckets with as many records as possible. By default, /NOFILL_BUCKETS is assumed. This qualifier is valid only for indexed output files.
/FIXED_CONTROL
/FIXED_CONTROL
/NOFIXED_CONTROL
Controls the behavior of CONVERT in conversions between VFC records
and other types of records (FIXED or VARIABLE).
If you specify /NOFIXED_CONTROL with VFC input records, the fixed
portion of the record is not copied to the output record.
If /NOFIXED_CONTROL is specified for VFC output records, the fixed
portion of the output record is set to 0.
If /FIXED_CONTROL is specified for VFC input records, the fixed
control portion of the record will be written as the first part of
the output record.
If /FIXED_CONTROL is specified for VFC output records, the fixed
control portion of the output record is taken from the first part of
the input record.
NOTE
When you use this qualifier, you must account for
the size of the fixed control area when calculating
the maximum size of the output record.
/KEY
/KEY[=n] Specifies the key of reference by which records are accessed from an indexed file. The /KEY option is valid only for indexed input files. If you specify an indexed output file, you must also specify /NOFAST and /NOSORT. The default is /KEY=0 (the primary key).
/MERGE
/MERGE Specifies that records are to be inserted into their proper position in an existing indexed file. If both /MERGE and /CREATE are specified, /MERGE overrides the /CREATE qualifier. When loading records into an empty indexed file or when creating a new indexed file, omit the /MERGE qualifier. This option is valid only for indexed output files.
/PAD
/PAD[=[%b]x]
/NOPAD
Controls whether short records are padded. A record is too short
when it does not contain as many bytes as the record length for
fixed-length record format.
The /PAD qualifier specifies which pad character will be used. Pad
characters are specified as follows:
Option Character
PAD NULL (00 Decimal)
PAD=x x is ASCII A-Z, a-z, or 0-9
PAD=%bx x is a number representing an ASCII character
b represents the base of the number. Values
for b are:
D = decimal
O = octal
X = hexadecimal
The default operation is /NOPAD, which causes an exception when a
short record is encountered.
The /PAD option is valid only for fixed output record formats.
/PROLOG
/PROLOG=n Specifies the prolog version number (n) of the output indexed file. If you specify a value of 2, the output file will be either a Prolog 1 or Prolog 2 file. If you specify 3, CONVERT will attempt to create a Prolog 3 file for output. If the output file cannot fit the criteria for Prolog 3, you will receive a fatal error and the conversion will not occur. If you do not specify the /PROLOG qualifier, then CONVERT uses the VAX-11 RMS default. To see what this is on your system, use the command SHOW RMS_DEFAULT. Using the /PROLOG qualifier overrides the value given with the FDL attribute KEY PROLOG.
/READ_CHECK
/READ_CHECK /NOREAD_CHECK Controls whether each input record is read from the file a second time and compared to the record originally read. By default, no read check is performed.
/SHARE
/SHARE /NOSHARE Controls whether the input file is to be opened for sharing with other processes. If /SHARE is specified, there is a chance that another process will alter the records at the same time CONVERT is operating. Thus, the consistency of the output data file cannot be guaranteed.
/SORT
/SORT /NOSORT Controls whether the input file is sorted before loading it into an indexed file. The sort is performed on the primary key of the output file. The /SORT qualifier is valid only with an indexed output file.
/SPREADSHEET
/SPREADSHEET
Invokes Xway, a program which translates data and models among many
popular spreadsheet programs. Xway also handles generic ASCII data
stored in tabular or field format, providing compatibility with
application programs and databases.
Xway is available as an interactive, menu-driven package with
extensive on-line, context-dependent help. Experienced users of the
interactive version can streamline operations with type-ahead. Xway
can be invoked on a DCL command line and also has a callable
interface.
This optional software product is available under separate license.
Format:
CONVERT/SPREADSHEET [input-file-spec] [output-file-spec]
For more information, invoke Xway and use the <HELP> key to see
Xway's on-line help, or refer to:
o VAX Xway User's Guide -- for information about running
Xway interactively.
o VAX Xway Programmer's Guide -- for information about
Xway's callable interface.
Additional information available:
FormatsCommand qualifiersParameter qualifiersOutput options
Release Notes
Formats
Xway exchanges information to and from the following formats:
DECalc command files
DECalc grids (binary)
Lotus 1-2-3 WKS (binary)
Lotus 1-2-3 WK1 (binary)
Lotus Symphony WRK (binary)
Multiplan SYLK
DIF (Data Interchange Format)
Generic ASCII tabular files
Generic ASCII field files
Model context information can be translated for model-to-model
exchanges.
Command qualifiers
Command qualifiers are used at DCL level and can appear anywhere on
the command line. Command qualifiers are optional.
Format:
$ CONVERT/SPREADSHEET [command_qualifiers]-
[input_filename] [parameter_qualifiers]-
[output_filename][parameter_qualifiers]
For more information, see the VAX Xway User's Guide.
/DEFINITION
/DEFINITION=filename
/NODEFINITION (default)
Allows you to restore a definition file containing Xway
parameters. This file can contain all information needed to
specify an exchange. Xway performs the exchange using the
information in the specified file instead of using information
entered at the terminal.
/INTERACTIVE
/INTERACTIVE (default)
/NOINTERACTIVE
Controls whether Xway invokes the menu interface. When in
INTERACTIVE mode, a Main Menu is displayed after you invoke Xway.
The /NOINTERACTIVE qualifier lets you use Xway without using the
menu interface; there is no user interaction. This qualifier is
useful when using Xway in a batch procedure or if you want to
suppress the menus.
When in /NOINTERACTIVE mode, you must supply all necessary
information on the command line for Xway to successfully perform
the exchange. You can specify a definition file which should
contain all the information Xway requires for the exchange.
/LOG
/LOG[=filename] (default)
/NOLOG
Indicates whether Xway displays status and error messages. You
can specify a file in which Xway records the log information. If
you do not specify a file with the /LOG qualifier, Xway displays
status and error messages on the terminal screen.
Additional information available:
Examples
1. $ CONVERT/SPREADSHEET/DEFINITION=WEEKLY_SPREADSHEET/NOINTERACTIVE
In this example, Xway uses the file, WEEKLY_SPREADSHEET.XWAY, as
the definition file. The definition file contains all the
information needed to perform the exchange. The /NOINTERACTIVE
qualifier suppresses the Xway menus and prompts.
2. $ CONVERT/SPREADSHEET/LOG=FOOBAR.LOG
In this example, all Xway status and error messages are recorded
in the file, FOOBAR.LOG.
Parameter qualifiers
Parameter qualifiers are used at DCL level and provide additional
information regarding the file immediately proceeding the qualifier.
Parameter qualifiers are optional.
Format:
$ CONVERT/SPREADSHEET [command_qualifiers]-
[input_filename] [parameter_qualifiers]-
[output_filename][parameter_qualifiers]
/DATE_EDIT_STRING
/DATE_EDIT_STRING="date edit string"
Specifies the format for the date in input or output files. Valid
characters for the date edit string are:
D represents a digit of the day of the month, 1 through 31
M represents a letter in the name of the month
N represents a digit in the number of the month, 1 through 12
Y represents a digit in the year
J represents a digit of the day in a year, 1 through 365
W represents a letter in the day of the week
B represents a blank (a space)
/ represents a slash
- represents a hyphen
. represents a period
(n) repeats the previous date edit string character 'n' times.
The 'n' must be a positive integer and cannot appear at the
beginning of the date edit string. If the value of 'n' is
zero (0), the previous character in the string is ignored.
/DISCARD
/DISCARD
/NODISCARD (default)
Specifies whether Xway should keep model context information (for
example, formatting and formulas). Using the /DISCARD qualifier
causes Xway to discard model formats and to produce a file
containing only data.
Since Xway translates information that cannot be exchanged
(formulas for which no equivalent exists in the target
spreadsheet) as labels, you may want to use the /DISCARD qualifier
to translate calculated data as constants during an exchange,
rather than labels.
/FORMAT
/FORMAT=type
Specifies the type of file Xway is processing. Input and output
filenames require a format specification. The format can be the
same for both files.
The types are as follows:
DECALC[=(option,...)]
LOTUS[=option]
DIF Data Interchange Format file
SYLK SYmbolic LinK file
FIELD ASCII field file
TABULAR ASCII tabular file
Use one of the following options for DECalc type files:
V22 DECalc V2.2 files
V30 DECalc V3.0 files [default]
COMMAND DECalc command files [default]
GRID DECalc grid files
Use one of the following options for LOTUS type files:
WKS LOTUS 1-2-3 V1.A binary worksheets
WK1 LOTUS 1-2-3 V2.0 binary worksheets
WRK LOTUS Symphony V1.0 binary worksheets
/RELOCATE
/RELOCATE[=(option[,option])]
/NORELOCATE (default)
Allows you to move an entire spreadsheet to the right or left and
up or down. The maximum number of rows or columns by which a
spreadsheet can be located is 65,535 in each direction.
You can use one or both of the following options.
ROW:n Moves the spreadsheet a specified number of rows.
COLUMN:n Moves the spreadsheet a specified number of columns.
Integers specified in an option can be positive or negative.
Negative integers move the grid up or to the left, omitting data
in the upper rows and right-hand columns of the grid. Positive
integers move the spreadsheet down or to the right, adding blank
rows and/or columns to the spreadsheet.
You should specify one option when using the /RELOCATE qualifier.
You are limited to specifying two options. Options should be
enclosed in parentheses; if using more than one option, separate
the options with a comma.
/SEPARATOR
/SEPARATOR="quoted string"
where:
"quoted string" is a string using up to 80 alphanumeric
characters. Some examples of valid separators
used in a "quoted string" are:
"*" asterisk
" " <space> character
" " <tab> character
"," comma (this is the default)
"" white space (this is only valid
for input files)
Defines the separator for an input or output tabular format file.
If used as a qualifier for an input file, Xway searches for the
specified separator when reading the file. If used for an output
file, Xway inserts the separator between data cells.
The separator is only used for tabular format files.
/TRAILING_SEPARATOR_COUNT
/TRAILING_SEPARATOR_COUNT=n
Indicates the number of separators appearing at the end of each
line in an output tabular format file. Use a positive integer
with this qualifier. The default value is zero (0).
SUPERCOMP-TWENTY requires two separators.
/TRANSPOSE
/TRANSPOSE
/NOTRANSPOSE (default)
Reverses the position of the rows and columns in a grid. Rows
become columns in a transposed grid (as if the grid is rotated
around a diagonal axis, from upper left to lower right corner).
The first row becomes the first column, and the left-to-right
sequence becomes a top-to-bottom sequence.
Additional information available:
Examples
1. CONVERT/SPREADSHEET BUDGET/FORMAT=FIELD -
/DATE_EDIT_STRING="DD/MMM/YYYY"
In this example, the input file, BUDGET.FLD uses DD/MMM/YYYY as
the format for dates where:
DD = the first two digits of the day in the month, 01 through 31
MMM = the first three letters of the month
YYYY = the four digits in the year
2. CONVERT/SPREADSHEET PAYROLL/FORMAT=(LOTUS:WKS) -
SALARY/FORMAT=(DECALC:V22COMMAND)
In this example, a Lotus 1-2-3 file, PAYROLL.WKS, is being
translated to a DECalc dump file, SALARY.DMP . All other
information required for the exchange would be entered by using
the Xway menus.
3. CONVERT/SPREADSHEET PAYROLL.WKS NEWPAYROLL.WKS/RELOCATE=(ROW:10,COL:10)
In this example, the file, PAYROLL.WKS, is relocated down ten
rows and moved ten rows to the right; blank rows and columns are
added to the model.
4. CONVERT/SPREADHSEET SALES/FORMAT=TABULAR/SEPARATOR="*" -
COST/FORMAT=(DECALC:V22COMMAND)
In this example, a tabular input file. SALES.TAB is being
translated to a DECalc dump file, COST.DMP. The separator used
in the tabular file is "*" .
5. CONVERT/SPREADSHEET STAFF/FORMAT=TABULAR -
/SEPARATOR="*"/TRAILING_SEPARATOR_COUNT=2
In this example, the input file, STAFF.TAB is a SUPERCOMP-TWENTY
file; therefore, the TRAILING_SEPARATOR_COUNT qualifier is used
to indicate that two separators appear at the end of every line
in the input file.
Output options
You can rearrange and manipulate output files with Xway options.
For more information, see the VAX Xway User's Guide.
The valid output options are:
RELOCATE Moves an entire grid (or file) up or down a number
of rows, and right or left a number of columns.
TRANSPOSE Reverses the row/column orientation. The columns
become rows and the rows become columns.
DISCARD Removes the model formatting information (such as
windows, titles, formulas, and cell formats).
Release Notes
A copy of the Xway release notes is contained in the file:
SYS$HELP:XWAY011.RELEASE_NOTES
The release notes include information regarding enhancements,
restrictions, and general notes. You can type or print this file to
read the release note information.
Additional information available:
Guidelines
DECalc output uses algebraic math mode.
Xway automatically sets the math mode to "algebraic" for DECalc
format output.
DECalc comments are omitted.
Any comments you have entered during a DECalc session are stripped
out of DECalc input files.
DECalc only reads dates in the format DD-MMM-YYYY.
Xway can output DECalc files containing dates that have been
formatted according to different date edit strings, but DECalc
does not read them. This restriction applies to DECalc version
2.2 and earlier.
No recursion checking is performed for DECalc exchanges.
Xway does not check whether the model you are translating into a
DECalc output format contains recursive references. DECalc does
not handle recursive references.
Xway does not handle the DECalc continuation character from table
files.
Long lines from tabular files (which are split into smaller
logical lines with the DECalc continuation character) are
exchanged as two or more separate lines by Xway.
Xway handles larger and smaller numbers (numbers with a greater
precision) than can DECalc.
Xway reports an overflow or underflow condition when it processes
a number that is too large or too small for the precision DECalc
can handle. Numbers that overflow or underflow are translated
into labels. DECalc's largest signed number is: + or -1.7E+38
and its smallest signed number is: + or -.29E-38.
Xway does not handle redundant cell referencing for SYLK input
files.
Xway does not parse "non-concise" (redundant) cell references from
Multiplan SYLK, such as: (R3:4 C1:61 C R3). Use only one "R" or
"C" per reference. For example,
SUM(R3:4 C1:61 C) should be written as SUM(R3:4 C)
ABS(R3:4 C[-1] R3) should be written as ABS(R3 C[-1])
Xway skips cells containing redundant cell references, and reports
an "invalid cell" message to the log.
You cannot specify a lowercase separator for tabular files when you
use the interactive, menu-driven version of Xway.
If you want a lowercase separator, specify it on the DCL command
line or edit the Definition file.
Lotus 1-2-3 version 1.0 does not allow cells to reference other
cells containing text.
1-2-3 changes to zero any cells that reference other cells
containing text. In the example below, cell B1 will contain zero.
A B C
1 "text" A1
Since Multiplan and DECalc do allow cells to reference other cells
containing text, models translated with Xway and read into Lotus
1-2-3 Version 1.0 may differ from the original.
/STATISTICS
/STATISTICS /NOSTATISTICS Controls whether CONVERT displays statistics about the conversion. The statistics displayed are: o Number of files processed o Total number of exception records encountered o Total number of valid records o Elapsed time o Buffered I/O count o Direct I/O count o Number of page faults o CPU time used o Name of the output file By default, no statistics are displayed.
Additional information available:
/TRUNCATE/WORK_FILES/WRITE_CHECK
/TRUNCATE
/TRUNCATE /NOTRUNCATE Controls whether long records are truncated. A record is too long when it exceeds either the maximum record length of the file or the record length for fixed record format. If a long record is encountered and /NOTRUNCATE is specified, the record is not written to the output file. If you specify the /EXCEPTIONS_FILE qualifier, the record itself is written untruncated to the exception file.
/WORK_FILES
/WORK_FILES=n Specifies the number of temporary work files to be used during the sort process. You may specify 0 or any value from 2 through 10. A value of 0 indicates that no work files are necessary because of sufficient physical memory. By default, two work files are used during a sort. This option is unnecessary if /NOSORT is specified.
/WRITE_CHECK
/WRITE_CHECK /NOWRITE_CHECK Controls whether all writes are checked by reading the new record and comparing it to the original. By default, no write check is performed.
Examples
1. $ CONVERT/FDL=INDEXFILE CUSTSEQ.DAT CUSTIND.DAT
This command processes the file CUSTSEQ.DAT according to the
specifications in the FDL file INDEXFILE.FDL and creates the new
file CUSTIND.DAT.
2. $ CONVERT/NOCREATE/TRUNCATE/EXCEPTIONS_FILE=EXFILE -
$_VARFILE.DAT FIXFILE.DAT
This command copies records from a file with variable-length records
(VARFILE.DAT) to a file with fixed-length records (FIXFILE.DAT). It
truncates variable-length records that are longer than the
fixed-length records in FIXFILE.DAT, and copies short records to the
exceptions file EXFILE.EXC.
3. $ CONVERT FILE.IDX FILE.IDX
This command creates the output file FILE.IDX with a version number
one higher than that of the input file. The output file is a copy
of the input file, but it is a clean copy; bucket splits and RRVs
(record reference vectors) disappear, and pointers to deleted
records are reclaimed. CONVERT also establishes new RFAs (record's
file addresses) during such reorganizations.
4. $ CONVERT/APPEND SALES.TMP KANSAS::[200,2]SALES.CMD
This CONVERT command causes records from the file SALES.TMP at the
local node to be added sequentially to the end of the output file
SALES.CMD at remote node KANSAS. The file SALES.TMP is sequential
with variable-length record format, and the file SALES.CMD is
sequential with stream record format. When the Convert Utility
loads records from the input file to the output file, it changes the
record format.
/DOCUMENT
Converts documents from one format to another for the purpose
of sharing information among different applications. Specify the
input file name and format and the output file name and format as
shown below.
The default input and output file format is DDIF (Digital Document
Interchange Format). DDIF is a standard format for the storage
and interchange of compound documents, which can include text,
graphics, and images.
Converters installed with the DEC CDA Base Services for VMS
DECwindows Motif are described below. Digital's CDA Converter
Library, a layered product that offers conversion among other
popular file formats, is separately installed and documented.
An /OPTIONS qualifier specifies a file containing options that
are applied to the input and output file to ensure that minimal
changes in format and content occur during the conversion.
A /MESSAGE_FILE qualifier creates a file to which informational
and error messages are logged during the conversion.
NOTE
The DEC CDA Base Services for VMS DECwindows Motif Version
1.0 or later must be installed in order to use the /MESSAGE_
FILE qualifier and new versions of the DEC CDA Base Services
converters.
Format
CONVERT/DOCUMENT infile/FORMAT=informat outfile/FORMAT=outformat
Additional information available:
Analysis Output ConverterDDIF Input ConverterDDIF Output ConverterDomain Converter
DTIF Input ConverterDTIF Output ConverterText Input ConverterText Output Converter
PostScript Output ConverterCreating the Options FileExampleValid Conversions
CDA$ Facility Messages
PARAMETERS
infile Specifies the name of the input file to be converted. The default file type is .DDIF. outfile Specifies the name of the output file. The default file type is .DDIF.
QUALIFIERS
Additional information available:
/FORMAT
/FORMAT=format-name
Specifies the encoding format of the input or output file. The
default input and output format is DDIF.
Input converters bundled with the DEC CDA Base Services for VMS
DECwindows Motif and the default file extensions for the file
formats they support are as follows:
Input Format File Extension
DDIF .DDIF
DTIF .DTIF
TEXT .TXT
Output converters bundled with the DEC CDA Base Services for VMS
DECwindows Motif and the default file extensions for the file
formats they support are as follows:
Output Format File Extension
DDIF .DDIF
DTIF .DTIF
TEXT .TXT
PS .PS
ANALYSIS .CDA$ANALYSIS
/OPTIONS
/OPTIONS=options-filename
Specifies a file that contains processing option for both input
and output. An options file is a text file with a default file
extension of .CDA$OPTIONS on VMS systems.
An options file is not required. Default processing options are
applied automatically when you convert a file. You may, however,
require settings other than the default. Processing options can
help ensure minimal changes when your input file is converted to a
different output file format.
/MESSAGE_FILE
/MESSAGE_FILE=filespec
/NOMESSAGE_FILE (default)
Turns on message logging for document conversion. Messages output
by the input and output converters are directed to the file
specified with filespec. If filespec is not specified, messages
are output to SYS$ERROR. The default is /NOMESSAGE_FILE.
Analysis Output Converter
The Analysis output converter produces an analysis of the
intermediate format of the input file. The analysis output file
shows the named objects and values stored in the input file.
Application programmers use an analysis output file for debugging
purposes.
Application end users use an analysis output file to determine
whether an input file contains references or links to multiple
subfiles. Each subfile must be copied separately across a network
because subfiles are not automatically included when an input file
is transferred across the network.
You can search the analysis output file for all occurrences of
the string "ERF_". The following example shows that the image file
"griffin.img" is linked to the DDIF compound document that is the
input file:
ERF_LABEL ISO LATIN1 "griffin.img" ! Char. string.
ERF_LABEL TYPE RMS_LABEL TYPE "$RMS:
ERF_CONTROL COPY_REFERENCE ! Integer = 1
Note that an analysis output file is intended as a programmer's
tool. The coded information in the file is not intended for
modification but rather to examine the content of a file. The
previous example shows how you can search analysis output for
references to linked files.
Additional information available:
Analysis Converter Options
The Analysis output converter supports the following options:
o TRANSLATE_BYTE_STRINGS
Overrides the default. For data of type BYTE STRING, the
analysis output no longer displays the hexadecimal translation
if all the characters in the byte string are printable
characters (hex values 20 through 7E). This feature may be
overridden by supplying the TRANSLATE_BYTE_STRINGS option.
o IMAGE_DATA
Overrides the default. For the special case of byte string
data for item DDIF$_IDU_PLANE_DATA (a bitmapped image), the
analysis output previously included both a hexadecimal and an
ASCII translation display, neither of which were of particular
value to most users. With the new version, both displays will
be replaced with the following comment:
! *** Bit-mapped data not displayed here ***
To retain the hexadecimal display, supply the IMAGE_DATA
option. Even with this option turned on, there will be no
translation into ASCII.
o INHERITANCE
Specifies that the analysis is shown with attribute inheritance
enabled. Inherited attributes are marked as "[Inherited
value.]" in the output. This option also causes external
references to be imported into the main document.
DDIF Input Converter
The DDIF input converter converts a compound document DDIF input file to an intermediate format that is then converted to the specified output file format. If the DDIF input file is a newer version of the DDIF grammar than that understood by the DDIF input converter, data represented by the new grammar elements is lost. The DDIF input converter does not resolve external references, although the converter kernel can if requested by the output converter. A document syntax error in the DDIF input file causes a fatal input processing error and conversion stops.
DDIF Output Converter
The DDIF output converter creates a compound document DDIF output file from the intermediate format of the input file.
Domain Converter
You may want to convert tabular input files to document output files so that you can include textual representations of data tables or spreadsheets in reports and other documents. You will, however, lose cell borders, headers, grid lines, all formulas, and font types when converting a tabular input file to a document output file. When you convert a tabular input file (for example, a DTIF file) to a document output file, the file format first undergoes an automatic domain conversion from a table format to a document format. The output is then converted to the document format you specified. You can create an options file containing processing options that apply to any CDA supported tabular file format for which there is an input converter. Data tables and spreadsheets are examples of tabular file formats. To convert tabular input files to document output files, use the DTIF_TO_DDIF format name, followed by the processing options listed below. Specify the DTIF_TO_DDIF processing options in addition to the processing options for a particular tabular input file format and a particular document output file format.
Additional information available:
COLUMN_TITLECURRENT_DATEDOCUMENT_DATEDOCUMENT_TITLE
PAGE_NUMBER
PAPER SIZE keywordPAPER HEIGHT valuePAPER WIDTH valuePAPER TOP MARGIN value
PAPER BOTTOM MARGIN valuePAPER LEFT MARGIN valuePAPER RIGHT MARGIN value
PAPER ORIENTATION keyword
COLUMN_TITLE
Displays the column titles as contained in the column attributes centered at the top of the column.
CURRENT_DATE
Displays the current date and time in the bottom left corner of the page. The value is formatted according to the document's specification for a default date and time.
DOCUMENT_DATE
Displays the document date and time as contained in the document header in the top left corner of the page. The value is formatted according to the document's specification for a default date and time.
DOCUMENT_TITLE
Displays the document title or titles as contained in the document header centered at the top of the page, one string per line.
PAGE_NUMBER
Displays the current page number in the top right corner of the page.
PAPER SIZE keyword
Specifies the size of the paper to be used when formatting the
file. Valid values for the size argument are as follows:
Keyword Size
A0 841 x 1189 millimeters (33.13 x 46.85
inches)
A1 594 x 841 millimeters (23.40 x 33.13
inches)
A2 420 x 594 millimeters (16.55 x 23.40
inches)
A3 297 x 420 millimeters (11.70 x 16.55
inches)
A4 210 x 297 millimeters (8.27 x 11.70
inches)
A5 148 x 210 millimeters (5.83 x 8.27
inches)
A 8.5 x 11 inches
B 11 x 17 inches
B4 250 x 353 millimeters (9.84 x 13.90
inches)
B5 176 x 250 millimeters (6.93 x 9.84
inches)
C 17 x 22 inches
C4 229 x 324 millimeters (9.01 x 12.76
inches)
C5 162 x 229 millimeters (6.38 x 9.02
inches)
D 22 x 34 inches
DL 110 x 220 millimeters (4.33 x 8.66
inches)
E 34 x 44 inches
10x13_ENVELOPE 13 x 254 millimeters (15.600 x 10
inches)
9x12_ENVELOPE 12 x 229 millimeters (14.400 x 9
inches)
BUSINESS_ENVELOPE 9.5 x 105 millimeters (11.400 x 4.13
inches)
EXECUTIVE 10 x 191 millimeters (12.000 x 7.5
inches)
LEDGER 11 x 17 inches
LEGAL 8.5 x 14 inches
LETTER 8.5 x 11 inches
LP 13.7 x 11 inches
VT 8 x 5 inches
The A paper size (8.5 x 11 inches) is the default.
PAPER HEIGHT value
Specifies a paper size other than one of the predefined values provided. The default paper height is 11 inches.
PAPER WIDTH value
Specifies a paper size other than one of the predefined sizes provided. The default paper width is 8.5 inches.
PAPER TOP MARGIN value
Specifies the width of the margin provided at the top of the page. The default value is 0.25 inch.
PAPER BOTTOM MARGIN value
Specifies the width of the margin provided at the bottom of the page. The default value is 0.25 inch.
PAPER LEFT MARGIN value
Specifies the width of the margin provided on the left-hand side of the page. The default value is 0.25 inch.
PAPER RIGHT MARGIN value
Specifies the width of the margin provided on the right-hand side of the page. The default value is 0.25 inch.
PAPER ORIENTATION keyword
Specifies the paper orientation to be used in the output file. The
valid values for the orientation argument are as follows:
Keyword Meaning
PORTRAIT The page is oriented so that the larger
dimension is parallel to the vertical axis.
LANDSCAPE The page is oriented so that the larger
dimension is parallel to the horizontal axis.
The default is PORTRAIT.
DTIF Input Converter
The DTIF input converter converts a DTIF input file to an intermediate format that is then converted to the specified output file format. DTIF (Digital Table Interchange Format) is a standard format for the storage and interchange of tabular data files, such as those created by spreadsheet and database applications. If the DTIF input file is a newer version of the DTIF grammar than that understood by the DTIF front end, data represented by the new grammar elements is lost. The DTIF input converter does not resolve external references. A document syntax error in the DTIF input file causes a fatal input processing error. A document syntax error in the DTIF input file causes a fatal input processing error and conversion stops.
DTIF Output Converter
The DTIF output converter converts the intermediate format of the input file to a DTIF output file. DTIF (Digital Table Interchange Format) is a standard format for the storage and interchange of tabular data files, such as those created by spreadsheet and database applications. The DTIF output converter converts external file references stored in the intermediate representation of the input file but does not resolve external references.
Text Input Converter
The Text input converter converts a Text (ISO Latin1) input file to an intermediate format that is then converted to the specified output file format. The information in the text input file maps directly to an intermediate representation. Line breaks and form feeds are mapped to DDIF directives. One or more contiguous blank lines are interpreted as end-of-paragraph markers. If the text input file was entered as a Digital Multinational Character Set file on a character-cell terminal or terminal emulator, the following conversions occur: Original Character Converted Character Concurrency sign Diaeresis Capital OE ligature Multiplication sign Capital Y with diaeresis Capital Y with acute accent Small oe ligature Division sign Small y with diaeresis Y with acute accent The text input file does not lose any information when converted to the intermediate representation because no structure information is contained in a text file. All nonprinting characters are converted to space characters. For example, characters introducing ANSI escape characters are converted to space characters. There is no attempt to interpret ANSI escape sequences.
Text Output Converter
The Text output converter converts the intermediate format of the input file to a Text output file. Text output files contain only textual content and minimal formatting such as line feeds, page breaks, and tabs. The output converter preserves formatting information to the extent possible. Page coordinates convert to the nearest character cell (line,column) position. All graphics, images, and text attributes in the input file are lost when converted to the text output file. Because a monospace font is used, it is possible some text may be lost due to overwriting to preserve the layout. Lines can be truncated if the specified page width is smaller than the page width specified in the document's format information. Neither of these cases occur when you use the OVERRIDE_FORMAT processing option because, in that case, the document's format information is ignored. The Text output converter supports the processing options listed below.
Additional information available:
ASCII_FALLBACK_[ON,OFF]CONTENT_MESSAGES_[ON,OFF]OVERRIDE_FORMAT_[ON,OFF]
SOFT_DIRECTIVES_[ON,OFF]
ASCII_FALLBACK_[ON,OFF]
Causes the Text output converter to output text in 7-bit ASCII. The fallback representation of the characters is described in the ASCII standard. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
CONTENT_MESSAGES_[ON,OFF]
Causes the Text output converter to put a message in the output file each time a nontext element is encountered in the intermediate representation of the input file. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
HEIGHT value
Specifies the maximum number of lines per page in your text output file. If you specify zero, the number of lines per page will correspond to the height specified in your document. If you also specify OVERRIDE_FORMAT, or if the document has no inherent page size, the document is formatted to the height value specified by this option. The default height is 66 lines.
OVERRIDE_FORMAT_[ON,OFF]
Causes the Text output converter to ignore the document formatting information included in your document, so that the text is formatted in a single large galley per page that corresponds to the size of the page as specified by the HEIGHT and WIDTH processing options. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
SOFT_DIRECTIVES_[ON,OFF]
Causes the Text output converter to obey the soft directives contained in the document when creating your text output file. If this option is not specified, the default is OFF; if this option is specified without a value, the default is ON.
WIDTH value
Specifies the maximum number of columns of characters per page in your text output file. If you specify zero, the number of columns per page will correspond to the width specified in your document. If you also specify OVERRIDE_FORMAT, or if the document has no inherent page size, the document is formatted to the value specified by this processing option. If any lines of text exceed this width value, the additional columns are truncated. The default width is 80 characters.
PostScript Output Converter
The PostScript output converter converts the intermediate format of the input file to a PostScript output file. The PostScript output converter supports the processing options listed below.
Additional information available:
EIGHT_BIT_OUTPUT_[ON,OFF]LAYOUT_[ON,OFF]PAGE_WRAP_[ON,OFF]
SOFT_DIRECTIVES_[ON,OFF]WORD_WRAP_[ON,OFF]
PAPER SIZE keywordPAPER HEIGHT valuePAPER WIDTH valuePAPER TOP MARGIN value
PAPER BOTTOM MARGIN valuePAPER LEFT MARGIN valuePAPER RIGHT MARGIN value
PAPER ORIENTATION keywordOUTPUT BUFFER SIZE value
PAPER SIZE keyword
Specifies the size of the paper to be used when formatting the resulting PostScript output file. Valid values for the size argument are as follows: Keyword Size A0 841 x 1189 millimeters (33.13 x 46.85 inches) A1 594 x 841 millimeters (23.40 x 33.13 inches) A2 420 x 594 millimeters (16.55 x 23.40 inches) A3 297 x 420 millimeters (11.70 x 16.55 inches) A4 210 x 297 millimeters (8.27 x 11.70 inches) A 8.5 x 11 inches B 11 x 17 inches C 17 x 22 inches D 22 x 34 inches E 34 x 44 inches LEDGER 11 x 17 inches LEGAL 8.5 x 14 inches LETTER 8.5 x 11 inches LP 13.7 x 11 inches VT 8 x 5 inches The A paper size (8.5 x 11 inches) is the default.
PAPER HEIGHT value
Specifies a paper size other than one of the predefined values provided. The default paper height is 11 inches (11 in). Other valid units of measurement are: centimeters (cm), millimeters (mm), and points (pt or po).
PAPER WIDTH value
Specifies a paper size other than one of the predefined sizes provided. The default paper width is 8.5 inches (8.5 in). Other valid units of measurement are: centimeters (cm), millimeters (mm), and points (pt or po).
PAPER TOP MARGIN value
Specifies the width of the margin provided at the top of the page. The default value is 0.25 inch (0.25 in). Other valid units of measurement are: centimeters (cm), millimeters (mm), and points (pt or po).
PAPER BOTTOM MARGIN value
Specifies the width of the margin provided at the bottom of the page. The default value is 0.25 inch (0.25 in). Other valid units of measurement are: centimeters (cm), millimeters (mm), and points (pt or po).
PAPER LEFT MARGIN value
Specifies the width of the margin provided on the left-hand side of the page. The default value is 0.25 inch (0.25 in). Other valid units of measurement are: centimeters (cm), millimeters (mm), and points (pt or po).
PAPER RIGHT MARGIN value
Specifies the width of the margin provided on the right-hand side of the page. The default value is 0.25 inch (0.25 in). Other valid units of measurement are: centimeters (cm), millimeters (mm), and points (pt or po).
PAPER ORIENTATION keyword
Specifies the paper orientation to be used in the output
PostScript file. The valid values for the orientation argument
are as follows:
Keyword Meaning
PORTRAIT The page is oriented so that the larger
dimension is parallel to the vertical axis.
LANDSCAPE The page is oriented so that the larger
dimension is parallel to the horizontal axis.
The default is PORTRAIT.
EIGHT_BIT_OUTPUT_[ON,OFF]
Specifies whether the PostScript output converter should use 8-bit output. The default value is ON.
LAYOUT_[ON,OFF]
Specifies whether the PostScript output converter processes the layout specified in the DDIF document. The default value is ON.
OUTPUT BUFFER SIZE value
Specifies the size of the output buffer. The value you specify must be within the range 64 to 256. The default value is 132.
PAGE_WRAP_[ON,OFF]
Specifies whether the PostScript output converter performs page wrapping of any text that would exceed the bottom margin. The default value is ON.
SOFT_DIRECTIVES_[ON,OFF]
Specifies whether the PostScript output converter processes soft directives in the DDIF file in order to format output. (Soft directives specify such formatting commands as new line, new page, and tab.) If the PostScript output converter processes soft directives, the output file will look more like you intended. The default value is ON.
WORD_WRAP_[ON,OFF]
Specifies whether the PostScript output converter performs word wrapping of any text that would exceed the right margin. The default value is ON. If you specify OFF, the PostScript output converter allows text to exceed the right margin.
Creating the Options File
You can create an options file prior to specifying the CONVERT
/DOCUMENT command with the /OPTIONS qualifier. An options file is
a text file with a default file extension of .CDA$OPTIONS on VMS
systems.
The options file contains all the processing options for your
input file format and your output file format. Processing options
help ensure minimal changes when your input file is converted to a
different output file format.
An options file is not required. Default processing options are
applied automatically when you convert a file. You may, however,
require settings other than the default.
Enter options in the options file using these formats, where
format is the name of the file format to which the option applies
and option is the option:
format_INPUT option applies only to an input file of the
specified format
format_OUTPUT option applies only to an output file of the
specified format
format option applies to either an input file or an output
file of the specified format
Use uppercase and lowercase alphabetic characters, digits (0-9),
dollar signs ($), and underscores (_) to specify the processing
options.
Use one or more spaces or tabs to precede values specified for a
processing option.
The following example is a typical entry in an options file:
PS PAPER_HEIGHT 10
In this example, the extension _OUTPUT is not required for the
format, since PostScript is available only as an output format.
The value specified for PAPER_HEIGHT is in inches by default.
If the options file includes options that do not apply to the
converters for a particular conversion, those options are ignored.
If you specify an invalid option for an input or output format or
an invalid value for an option, you receive an error message. The
processing options described in the following sections document
any restrictions.
Example
$ CONVERT/DOCUMENT -
_$ /OPTIONS=MY_OPTIONS.CDA$OPTIONS -
_$ MY_INPUT.DTIF/FORMAT=DTIF -
_$ MY_OUTPUT.DDIF/FORMAT=DDIF
_$ /MESSAGE_FILE=MY_MSGS.MSG
This command converts an input file named MY_INPUT.DTIF, which
has the DTIF format, to an output file named MY_OUTPUT.DDIF,
which has the DDIF format. The specified options file is named
MY_OPTIONS.CDA$OPTIONS, and the message file is named /MESSAGE_
FILE=MY_MSGS.MSG.
Valid Conversions
You can convert an input file to an output file that is of the same type: document, tabular, graphics, or image. The DDIF and Text converters support conversion between document file formats. The Analysis output converter is a type of document converter that produces an analysis of the objects and values stored in an input file. The DTIF converters support conversion between tabular file formats. You can convert a tabular input file format to a document output file format. The domain converter provides this capability. You can convert a graphics or image input file to a compound document output file format that supports graphics and image elements. You can convert a compound document input file containing graphics or images to a graphics or image output file, but any text in the file is lost. If Digital's CDA Converter Library or other third-party converters are installed, you can convert files among other popular file formats in addition to those supported by the DEC CDA Base Services converters.
CDA$ Facility Messages
The CDA$_ facility messages that can be returned during the conversion of your document are described here. A brief explanation and recommended user action follows each message, unless a user action is not required. The messages are listed in alphabetical order, by message name.
Additional information available:
AGGCNTALLOCFAILCLOSEFAILDCVNOTFNDDEFAULTDEFNOTFOU
EMPTYENDOFDOCENDOFSEQERRINPLOGERROUTLOG
FILESPECFLTTRNICVNOTFNDINDEXINFINPLOGINFOUTLOG
INHERITINTERRINVADDINFINVAGGCTXINVAGGTYP
INVBUFLENINVDATLENINVDOCINVFLTVALINVFUNCOD
INVINPDMNINVINSERTINVITMCODINVITMLSTINVOPTION
INVOUTDMNINVSCOCODINVSCOTRANINVSTSCOD
INVTAGCODITMAGGCNTMISEXTREFMISSTYGDE
NORMALOCVNOTFNDOPENFAILREADFAILREADONLYREQITMMIS
SUSPENDTYPEREFUNRECENCUNSUPCNVUNSUPFMTVAREMPTYVARINDEX
VARVALUEVERSKEWWRITFAIL
AGGCNT
aggregate type: !AD Agg count: !ZL Level: Informational Explanation: Aggregate type: 'string' Agg count: 'integer' This is info on the aggregate name, and the count of the aggregate type.
ALLOCFAIL
memory allocation failure Level: Error Explanation: The standard memory allocation procedure failed to allocate dynamic memory.
CLOSEFAIL
close failure Level: Error Explanation: The standard close function has failed.
DCVNOTFND
domain converter not found Level: Error Explanation: The required domain converter could not be found.
DEFAULT
item present by default Level: Success Explanation: The application called CDA$LOCATE_ITEM, which determined that the item was present by default in the input stream.
DEFNOTFOU
definition not found Level: Error Explanation: The application called CDA$FIND_DEFINITION referencing an entity that is not defined.
EMPTY
empty item Level: Error Explanation: The application called a CDA access procedure referencing an item that is empty.
ENDOFDOC
end of document Level: Error Explanation: The application called CDA$GET_AGGREGATE, which determined that no more aggregates exist in the document.
ENDOFSEQ
end of sequence Level: Error Explanation: The application called CDA$NEXT_AGGREGATE referencing an aggregate that was at the end of a sequence.
ERRINPLOG
error messages produced during input conversion, see error log Level: Error Explanation: The input conversion did not complete and some error messages were produced. User Action: Refer to the error log for more details.
ERROUTLOG
error messages produced during output conversion, see error log Level: Error Explanation: The output conversion did not complete and some error messages were produced. User Action: Refer to the error log for more details.
FILESPEC
missing filespec Level: Informational Explanation: Missing filespec: 'filespec' This is the name of the missing filespec.
FLTTRN
floating-point truncation Level: Error Explanation: During CDA$LOCATE_ITEM for a general floating-point value, floating truncation occurred.
ICVNOTFND
input converter not found Level: Error Explanation: The specified input converter could not be found.
INDEX
index out of range Level: Error Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_ ITEM, or CDA$ERASE_ITEM referencing an array-valued item, but the index is out of range.
INFINPLOG
informational messages produced during input conversion, see error log Level: Informational Explanation: The input conversion completed but some informational messages were produced. User Action: Refer to the error log for more details.
INFOUTLOG
informational messages produced during output conversion, see error log Level: Informational Explanation: The output conversion completed but some informational messages were produced. User Action: Refer to the error log for more details.
INHERIT
item present by inheritance Level: Success Explanation: The application called CDA$LOCATE_ITEM, which determined that the item was present by inheritance in the input stream.
INTERR
internal error Level: Fatal Explanation: The CDA Toolkit detected an internal error.
INVADDINF
invalid additional information Level: Error Explanation: The add-info parameter in a call to CDA$LOCATE_ITEM or CDA$STORE_ITEM is invalid.
INVAGGCTX
invalid aggregate context Level: Error Explanation: The user called PUT AGGREGATE, PUT DOCUMENT, or ENTER SCOPE with an aggregate that is invalid in its context in the document
INVAGGTYP
invalid aggregate type Level: Error Explanation: The application called a CDA access procedure referencing an aggregate type code that is undefined, or an aggregate that has an undefined type code.
INVBUFLEN
invalid buffer length Level: Error Explanation: The application called CDA$_STORE_ITEM referencing an item that is required to have a specified buffer length. The value of the buffer length parameter is not the required value.
INVDATLEN
invalid data length Level: Error Explanation: The length of the value data exceeded the specified length for the data type.
INVDOC
invalid document syntax Level: Error Explanation: The CDA access procedures determined that the document contains invalid syntax.
INVFLTVAL
invalid floating-point value Level: Error Explanation: A floating-point datum has a reserved value.
INVFUNCOD
invalid function code Level: Error Explanation: The application called CDA$CONVERT with an invalid function code.
INVINPDMN
invalid input domain Level: Error Explanation: An invalid input domain was specified for the front end. Only DDIF and DTIF are supported as domains.
INVINSERT
invalid insert Level: Error Explanation: The application called CDA$INSERT_AGGREGATE or CDA$STORE_ITEM referencing an aggregate that was already part of a sequence, but was not the first aggregate of the sequence.
INVITMCOD
invalid item code Level: Error Explanation: The application called a CDA access procedure referencing an aggregate item code that is not defined.
INVITMLST
invalid item list Level: Error Explanation: The application called CDA$OPEN_FILE or CDA$CREATE_ ROOT_AGGREGATE with a processing options item list that contained an invalid item.
INVOPTION
invalid converter option Level: Error Explanation: An invalid option was specified for the converter. User Action: Refer to the documentation for this converter to see the valid options.
INVOUTDMN
invalid output domain Level: Error Explanation: An invalid output domain was specified for the back end. Only DDIF and DTIF are supported as domains.
INVSCOCOD
invalid scope code Level: Error Explanation: The application called CDA$ENTER_SCOPE or CDA$LEAVE_ SCOPE referencing a scope code that is not defined or invalid in following correct document scoping rules.
INVSCOTRAN
invalid scope transition Level: Error Explanation: The application made a call to CDA$ENTER_SCOPE or CDA$LEAVE_SCOPE that did not follow correct scoping rules.
INVSTSCOD
invalid status code Level: Error Explanation: The specified status code's associated message could not be found.
INVTAGCOD
invalid tag code Level: Error Explanation: The application called CDA$_STORE_ITEM referencing an item that has a special tag encoding, but the value of the add-info parameter is not defined for the item.
ITMAGGCNT
aggregate item code: !ZL Aggregate type: !AD Agg count: !ZL Level: Informational Explanation: Aggregate item code: 'integer' Aggregate type: 'string' Agg count: 'integer' This is info on an item missing, aggregate name, and the count of the aggregate type.
MISEXTREF
external reference file missing or could not be read Level: Warning Explanation: An external reference file is missing or could not be read. A document's external reference could not be found, read, or processed.
MISSTYGDE
style guide file missing or could not be read Level: Warning Explanation: Style guide file missing or could not be read. A document's external style guide could not be found, read, or processed.
NORMAL
normal successful completion Level: Success Explanation: The specified action has been successfully completed.
OCVNOTFND
output converter not found Level: Error Explanation: The specified output converter could not be found.
OPENFAIL
open failure Level: Error Explanation: The standard open function has failed.
READFAIL
read failure Level: Error Explanation: The standard read function has failed.
READONLY
aggregate is read-only Level: Error Explanation: The application requested input processing options that require an aggregate to be read-only. The application attempted to write or delete the aggregate.
REQITMMIS
required item missing Level: Error Explanation: The user called PUT AGGREGATE, PUT DOCUMENT, or ENTER SCOPE with an aggregate that contains an item which is required, but empty.
SUSPEND
converter is suspended Level: Success Explanation: The application called CDA$CONVERT, which determined that the back end suspended conversion. This message can only be returned by the CDA viewer.
TYPEREF
reference to undefined type name Level: Informational Explanation: The definition of type typeref was not found.
UNRECENC
Unrecognized encodings skipped Level: Success, Informational Explanation: This success status is returned by the GET AGGREGATE and GET DOCUMENT routines if unrecognized data in the input encoding is skipped. This informational status is logged to the common message log by the bundled DDIF and DTIF converter front ends if data is skipped during the reading within the front-end conversion.
UNSUPCNV
unsupported document conversion Level: Error Explanation: The input and output document formats are incompatible for conversion.
UNSUPFMT
unsupported document format Level: Error Explanation: The application called CDA$CONVERT with an unsupported document format name. The document format name may be misspelled, or the required conversion module may not be installed.
VAREMPTY
empty variant item (OBSOLETE) Level: Error Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_ ITEM, or CDA$ERASE_ITEM referencing an item that has a variable data type. The item that specifies the data type is empty.
VARINDEX
variant index out of range (OBSOLETE) Level: Error Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_ ITEM, or CDA$ERASE_ITEM referencing an array-valued item that has a variable data type, but the index is out of range for the item that specifies the data type.
VARVALUE
variant value out of range Level: Error Explanation: The application called CDA$LOCATE_ITEM, CDA$STORE_ ITEM, or CDA$ERASE_ITEM referencing an item that has a variable data type, but the item that specifies the data type has an invalid value.
VERSKEW
major version skew between input file and CDA Toolkit Level: Error Explanation: The file's major version is different from the Toolkit's. Thus, the Toolkit cannot properly process the file.
WRITFAIL
write failure Level: Error Explanation: The standard write function has failed.
/RECLAIM
Invokes the VMS Convert/Reclaim Utility (CONVERT/RECLAIM) to make
empty buckets in Prolog 3 indexed files available so that new
records can be written in them. If all the records in a bucket
have been deleted, that bucket is locked until CONVERT/RECLAIM
makes it available. Unlike CONVERT, CONVERT/RECLAIM maintains
record file addresses (RFAs). The /RECLAIM qualifier is required.
For a complete description of the Convert/Reclaim Utility,
including more information about the CONVERT/RECLAIM command and
its qualifier, see the VMS Convert and Convert/Reclaim Utility
Manual.
Format:
CONVERT/RECLAIM file-spec
Additional information available:
ParametersCommand QualifiersExample
Parameters
file-spec Specifies the Prolog 3 indexed file in which you want to reclaim buckets. This file cannot be opened for shared access during bucket reclamation.
Command Qualifiers
Additional information available:
/STATISTICS
/STATISTICS /NOSTATISTICS Controls whether statistics are displayed about the conversion when it is completed. The statistics displayed are: o Total buckets scanned o Data buckets reclaimed o Index buckets reclaimed o Total buckets reclaimed o Elapsed time o CPU time By default, no statistics are displayed.
Example
1. $ CONVERT/RECLAIM CUSTDATA.IDX
This command causes the Convert/Reclaim Utility to reclaim
buckets in the indexed file CUSTDATA.IDX.