VMS Help CONV$ Routines, CONV$RECLAIM  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The CONV$RECLAIM routine invokes the functions of the
    Convert/Reclaim utility.

    Format

      CONV$RECLAIM  input_filespec [,statistics_blk] [,flags]

                    [key_number]

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
    Name of the Prolog 3 indexed file to be reclaimed. The input_
    filespec argument is the address of a string descriptor pointing
    to the name of the Prolog 3 indexed file.

 statistics_blk

    OpenVMS usage:vector_longword_unsigned
    type:         longword (unsigned)
    access:       modify
    mechanism:    by reference
    Bucket reclamation statistics. The statistics_blk argument is the
    address of a variable-length array of longwords that receives
    statistics on the bucket reclamation. You can choose which
    statistics you want returned by specifying a number in the first
    element of the array. This number determines how many of the four
    possible statistics the routine returns.

    You can request bucket reclamation statistics using symbolic
    names or numeric offsets into the variable-length array of
    longwords that contains the statistics. The array is defined
    as a structure of named longwords (RECL$STATISTICS) to support
    access by high-level progamming languages.

    Bucket Reclamation Statistics Array lists the array elements by
    number and by symbol. The first element specifies one or more
    statistics by array order. For example, if you assign the symbol
    RECL$L_STATISTICS_COUNT the value 3, the routine returns the
    statistics from the first three statistics elements:

    o  Data buckets scanned

    o  Data buckets reclaimed

    o  Index buckets reclaimed

    Table 5-3 Bucket Reclamation Statistics Array

    Array
    ElementField Name             Description

     0     RECL$L_STATISTICS_     Number of statistics specified
           COUNT
     1     RECL$L_SCAN_COUNT      Data buckets scanned
     2     RECL$L_DATA_COUNT      Data buckets reclaimed
     3     RECL$L_INDEX_COUNT     Index buckets reclaimed
     4     RECL$L_TOTAL_COUNT     Total buckets reclaimed

 flags

    OpenVMS usage:mask_longword
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Flags (or masks) that control how the fdl_filespec argument,
    used in calls to the CONV$PASS_FILES routine, is interpreted and
    how errors are signaled. The flags argument is the address of a
    longword containing control flags (or a mask). If you omit the
    flags argument or specify it as zero, no flags are set. The flag
    is defined as follows:

    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.

 key_number

    OpenVMS usage:address
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    The optional key_number argument permits the calling program to
    selectively reclaim buckets by key number. If the calling program
    omits this argument or passes a NULL value in the argument, all
    buckets are reclaimed, without regard to key designation. If the
    calling program passes a valid key number as the value for this
    argument, the routine reclaims only the buckets for the specified
    key.

3 - Condition Values Returned

    SS$_NORMAL         Normal successful completion.
    CONV$_BADLOGIC     Internal logic error detected.
    CONV$_INSVIRMEM    Insufficient virtual memory.
    CONV$_INVBKT       Invalid bucket at VBN n.
    CONV$_NOTIDX       File is not an indexed file.
    CONV$_NOWILD       No wildcard permitted.
    CONV$_OPENIN       Error opening file specification as input.
    CONV$_PLV          Unsupported prolog version.
    CONV$_PROERR       Error reading prolog.
    CONV$_PROL_WRT     Prolog write error.
    CONV$_READERR      Error reading file specification.
    CONV$_WRITEERR     Error writing output file.