HELPLIB.HLB  —  CONV$ Routines, CONV$PASS_FILES
    The CONV$PASS_FILES routine specifies a file to be converted
    using the CONV$CONVERT routine.

    Format

      CONV$PASS_FILES  input_filespec ,output_filespec

                       [,fdl_filespec] [,exception_filespec]

                       [,flags]

1  –  Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

    Longword condition value. Most utility routines return a
    condition value in R0. Condition values that this routine can
    return are listed under Condition Values Returned.

2  –  Arguments

 input_filespec

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor-fixed-length string descriptor
    The name of the file to be converted. The input_filespec argument
    is the address of a string descriptor pointing to the name of the
    file to be converted.

 output_filespec

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor-fixed-length string descriptor
    The name of the file that receives the records from the input
    file. The output_filespec argument is the address of a string
    descriptor pointing to the name of the file that receives the
    records from the input file.

 fdl_filespec

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor-fixed-length string descriptor
    The name of the FDL file that defines the output file. The fdl_
    filespec argument is the address of a string descriptor pointing
    to the name of the FDL file.

 exception_filespec

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       read only
    mechanism:    by descriptor-fixed-length string descriptor
    The name of the file that receives copies of records that cannot
    be written to the output file. The exception_filespec argument is
    the address of a string descriptor pointing to this name.

 flags

    OpenVMS usage:mask_longword
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Flags (or masks) that control how the fdl_filespec argument is
    interpreted and how errors are signaled. The flags argument
    is the address of a longword containing the control flags (or
    mask). If you omit this argument or specify it as zero, no flags
    are set. If you specify a flag, it remains in effect until you
    explicitly reset it in a subsequent call to a CONVERT routine.

    The flags and their meanings are described in the following
    table:

    Flag             Function

    CONV$V_FDL_      Interprets the fdl_filespec argument as an FDL
    STRING           specification in string form. By default, this
                     argument is interpreted as a file name of an FDL
                     file.
    CONV$V_SIGNAL    Signals any error. By default, the status code
                     is returned to the calling image.

    By default, an error status is returned rather than signaled.

3  –  Description

    The CONV$PASS_FILES routine specifies a file to be converted
    using the CONV$CONVERT routine. A single call to CONV$PASS_FILES
    allows you to specify an input file, an output file, an FDL file,
    and an exception file. If you have multiple input files, you must
    call CONV$PASS_FILES once for each file. You need to specify only
    the input_filespec argument for the additional files, as follows:

    status = CONV$PASS_FILES (input_filespec)

    The additional calls must immediately follow the original call
    that specified the output file specification.

    Wildcard characters are not allowed in the file specifications
    passed to the CONVERT routines.

4  –  Condition Values Returned

    SS$_NORMAL         Normal successful completion.
    CONV$_INP_FILES    Too many input files.
    CONV$_INSVIRMEM    Insufficient virtual memory.
    CONV$_NARG         Wrong number of arguments.
    CONV$_ORDER        Routine called out of order.
Close Help