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

    Closes the currently open mail file.

    Format

      MAIL$MAILFILE_CLOSE  context ,in_item_list ,out_item_list

1 - Returns

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

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

2 - Arguments

 context

    OpenVMS usage:context
    type:         longword (unsigned)
    access:       modify
    mechanism:    by reference
    Mail file context information to be passed to mail file routines.
    The context argument is the address of a longword that contains
    mail file context information returned by MAIL$MAILFILE_BEGIN.

 in_item_list

    OpenVMS usage:itmlst_3
    type:         longword (unsigned)
    access:       read only
    mechanism:    by reference
    Item list specifying options for the routine. The in_item_list
    argument is the address of a list of item descriptors, each of
    which specifies an option and provides the information needed to
    perform the operation.

    The item list is terminated by longword value of 0.

3 - Input Item Codes

 MAIL$_MAILFILE_FULL_CLOSE

    The Boolean item code MAIL$_MAILFILE_FULL_CLOSE specifies that
    MAIL$MAILFILE_CLOSE should purge the wastebasket folder when it
    closes the mail file. If the number of bytes deleted by the purge
    operation exceeds a system-defined threshold, the Mail utility
    reclaims the deleted space from the mail file.

    Specify the value 0 in the buffer length and buffer address
    fields of the item descriptor.

    The system-defined threshold is reserved by Compaq.

 out_item_list

    OpenVMS usage:itmlst_3
    type:         longword
    access:       write only
    mechanism:    by reference
    Item list specifying the information you want the routine to
    return. The out_item_list argument is the address of a list of
    item descriptors, each of which describes an item of information.
    The list of item descriptors is terminated by longword value of
    0.

4 - Output Item Codes

 MAIL$_MAILFILE_DATA_RECLAIM

    When you specify MAIL$_MAILFILE_DATA_RECLAIM, MAIL$MAILFILE_CLOSE
    returns the number of data buckets reclaimed during the reclaim
    operation as a longword value.

 MAIL$_MAILFILE_DATA_SCAN

    When you specify MAIL$_MAILFILE_DATA_SCAN, MAIL$MAILFILE_CLOSE
    returns the number of data buckets scanned during the reclaim
    operation as a longword value.

 MAIL$_MAILFILE_INDEX_RECLAIM

    When you specify MAIL$_MAILFILE_INDEX_RECLAIM, MAIL$MAILFILE_
    CLOSE returns the number of index buckets reclaimed during a
    reclaim operation as a longword value.

 MAIL$_MAILFILE_MESSAGES_DELETED

    When you specify MAIL$_MAILFILE_MESSAGES_DELETED, MAIL$MAILFILE_
    CLOSE returns the number of messages deleted as a longword value.

 MAIL$_MAILFILE_TOTAL_RECLAIM

    When you specify MAIL$_MAILFILE_TOTAL_RECLAIM, MAIL$MAILFILE_
    CLOSE returns the number of bytes reclaimed during a reclaim
    operation as a longword value.

5 - Description

    If you specify the input item code MAIL$_MAILFILE_FULL_CLOSE,
    this procedure purges the wastebasket folder automatically
    before it closes the file. If the number of bytes deleted by this
    procedure exceeds the deleted byte threshold, the system performs
    a convert/reclaim operation on the file.

6 - Condition Values Returned

    SS$_NORMAL         Normal successful completion.
    MAIL$_INVITMCOD    The specified item code is invalid.
    MAIL$_INVITMLEN    The specified item length is invalid.
    MAIL$_MISREQITEM   The required item is missing.
    MAIL$_NOFILEOPEN   No mail file is open.
    SS$_ACCVIO         Access violation.