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

    Terminates mail file processing.

    Format

      MAIL$MAILFILE_END  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
    MAILFILE context information returned by MAIL$MAILFILE_BEGIN.

    If mail file processing is terminated successfully, the Mail
    utility sets the value of the argument context to 0.

 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 requests that
    the wastebasket folder be purged and that convert and reclaim
    operations be performed, if necessary.

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

 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

    None.

5 - Description

    The MAIL$MAILFILE_END routine deallocates the mail file context
    created by MAIL$MAILFILE_BEGIN as well as any dynamic memory
    allocated by other mail file processing routines.

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.
    SS$_ACCVIO         Access violation.
    Any condition value returned by LIB$FREE_VM.