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

    Removes a record from the user profile database.

    Format

      MAIL$USER_DELETE_INFO  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 send routines. The
    context argument is the address of a longword that contains user
    context information returned by MAIL$USER_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 must include at least one device item descriptor.
    The item list is terminated by longword value of 0.

3 - Input Item Codes

 MAIL$_USER_USERNAME

    MAIL$_USER_USERNAME specifies the record to be deleted from
    the user profile database. The buffer address field of the item
    descriptor points to a buffer that contains the user name string
    encoded in a character string 0 to 31 characters long.

    Specify a value from 0 to 31 in the buffer length field of the
    item descriptor.

    The item code MAIL$_USER_USERNAME is required.

 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

    To delete a record from the user profile database, you must have
    SYSPRV privilege.

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$_NOSUCHUSR    The specified user name is not valid.
    MAIL$_NOSYSPRV     The operation requires the SYSPRV privilege.
    SS$_ACCVIO         Access violation.