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

    Deletes messages contained in the wastebasket folder of the
    currently open mail file.

    Format

      MAIL$MAILFILE_PURGE_WASTE  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 other mail file
    routines. The context argument is the address of a longword that
    contains mail file context information.

 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_RECLAIM

    The Boolean item code MAIL$_MAILFILE_RECLAIM specifies that
    MAIL$MAILFILE_PURGE_WASTE purge the wastebasket folder and
    reclaim deleted space in the mail file.

    Specify the value 0 in the buffer length field of the item
    descriptor.

    MAIL$_MAILFILE_RECLAIM explicitly requests a reclaim operation
    and overrides the deleted byte's threshold regardless of the
    number of bytes deleted during a mail file purge operation.

 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_
    PURGE_WASTE 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_PURGE_
    WASTE 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, the Mail utility
    returns the number of index buckets reclaimed during a reclaim
    operation as a longword value.

 MAIL$_MAILFILE_DELETED_BYTES

    When you specify MAIL$_MAILFILE_DELETED_BYTES, MAIL$MAILFILE_
    PURGE_WASTE returns the number of bytes deleted from the mail
    file as a longword value.

 MAIL$_MAILFILE_MESSAGES_DELETED

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

 MAIL$_MAILFILE_TOTAL_RECLAIM

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

5 - Description

    If you specify the MAIL$_MAILFILE_RECLAIM item descriptor,
    all the bytes deleted from the mail file by this routine are
    reclaimed.

6 - Condition Values Returned

    MAIL$_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 currently open.
    MAIL$_NOTISAM      The message file is not an indexed file.
    SS$_ACCVIO         Access violation.