VMS Help  —  MAIL Routines, MAIL$USER_END
    Terminates access to the user profile database.

    Format

      MAIL$USER_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
    User context information to be passed to user routines. The
    context argument is the address of a longword that contains user
    context information.

    If the Mail utility terminates access to the user profile
    database successfully, the value of the argument context is
    changed 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. This routine does
    not use the in_item_list argument.

 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. This routine does not use the out_item_list argument.

3  –  Description

    The MAIL$USER_END routine deallocates the user database context
    created by MAIL$USER_BEGIN as well as all dynamic memory
    allocated by previous user routines.

4  –  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.
Close Help