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

    Adds or modifies a specified user record in the user profile
    database.

    Format

      MAIL$USER_SET_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 user 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_CREATE_IF

    The Boolean item code MAIL$_USER_CREATE_IF specifies that
    MAIL$USER_SET_INFO should create the record for the specified
    user if it does not already exist.

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

 MAIL$_USER_SET_AUTO_PURGE

    The Boolean item codes MAIL$_USER_SET_AUTO_PURGE and MAIL$_
    USER_SET_NO_AUTO_PURGE set and clear the auto purge flag for
    the specified user.

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

 MAIL$_USER_SET_CC_PROMPT

    The Boolean item codes MAIL$_USER_SET_CC_PROMPT and MAIL$_
    USER_SET_NO_CC_PROMPT set and clear the cc prompt flag for the
    specified user.

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

 MAIL$_USER_SET_COPY_FORWARD

    The Boolean item codes MAIL$_USER_SET_COPY_FORWARD and MAIL$_
    USER_SET_NO_COPY_FORWARD set and clear the copy self forward flag
    for the specified user.

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

 MAIL$_USER_SET_COPY_REPLY

    The Boolean item codes MAIL$_USER_SET_COPY_REPLY and MAIL$_USER_
    SET_NO_COPY_REPLY set and clear the copy self reply flag for the
    specified user.

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

 MAIL$_USER_SET_COPY_SEND

    The Boolean item codes MAIL$_USER_SET_COPY_SEND and MAIL$_USER_
    SET_NO_COPY_SEND set and clear the copy self send flag for the
    specified user.

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

 MAIL$_USER_SET_EDITOR

    MAIL$_USER_SET_EDITOR specifies the name of a default editor to
    be used by the specified user. The buffer address field of the
    item descriptor points to a buffer that contains a character
    string 0 to 255 characters long.

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

    The Boolean item code MAIL$_USER_SET_NO_EDITOR clears the default
    editor field for the specified user.

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

 MAIL$_USER_SET_FORM

    MAIL$_USER_SET_FORM specifies the default print form string
    for the specified user. The buffer address field of the item
    descriptor points to a buffer that contains a character string 0
    to 255 characters long.

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

    The Boolean item code MAIL$_USER_SET_NO_FORM clears the default
    print form field for the specified user.

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

 MAIL$_USER_SET_FORWARDING

    MAIL$_USER_SET_FORWARDING specifies a forwarding address string
    for the specified user. The buffer address field of the item
    descriptor points to a buffer that contains a character string 0
    to 255 characters long.

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

    The Boolean item code MAIL$_USER_SET_NO_FORWARDING clears the
    forwarding address field for the specified user.

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

 MAIL$_USER_SET_NEW_MESSAGES

    MAIL$_USER_SET_NEW_MESSAGES specifies the new message count
    for the specified user. The buffer address field of the item
    descriptor points to a word that contains the new number of new
    messages.

 MAIL$_USER_SET_PERSONAL_NAME

    MAIL$_USER_SET_PERSONAL_NAME specifies a personal name string
    for the specified user. The buffer address field of the item
    descriptor points to a buffer that contains a character string 0
    to 127 characters long.

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

    The Boolean item code MAIL$_USER_SET_NO_PERSONAL_NAME clears the
    personal field for the specified user.

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

 MAIL$_USER_SET_QUEUE

    MAIL$_USER_SET_QUEUE specifies a default print queue name string
    for the specified user. The buffer address field of the item
    descriptor points to a buffer that contains a character string 0
    to 255 characters long.

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

    The Boolean item code MAIL$_USER_SET_NO_QUEUE clears the default
    print queue field for the specified user.

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

 MAIL$_USER_SET_SIGFILE

    MAIL$_USER_SET_SIGFILE specifies a signature file specification
    for the specified user. The buffer address field of the item
    descriptor points to a buffer that contains a character string 0
    to 255 characters long.

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

    The Boolean item code MAIL$_USER_SET_NO_SIGFILE clears the
    signature file field for the specified user.

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

 MAIL$_USER_SET_SUB_DIRECTORY

    MAIL$_USER_SET_SUB_DIRECTORY specifies a MAIL subdirectory. The
    buffer address field of the item descriptor points to a buffer
    that contains a character string 0 to 255 characters long.

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

    The Boolean item code MAIL$_USER_SET_NO_SUB_DIRECTORY disables
    the use of a MAIL subdirectory for the specified user.

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

 MAIL$_USER_USERNAME

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

    Specify a value from 0 to 31 in the buffer length field 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$USER_SET_INFO routine modifies specified records in
    the user profile database. If you do not specify a user name,
    the routine modifies the user record associated with the calling
    process.

    To modify any user record other than that associated with the
    calling process, you must have SYSPRV privilege. However, if
    you want to add or modify only the forwarding address of another
    user, SYSNAM privilege is sufficient.

6 - Condition Values Returned

    SS$_NORMAL         Normal successful completion.
    MAIL$_CONITMCOD    The specified item codes perform conflicting
                       operations.
    MAIL$_ILLCHAR      Unacceptable character in personal name.
                       Utility returns three formatted ASCII
                       output (FAO) arguments including the illegal
                       character, the length of the string, and the
                       string address.
    MAIL$_ILLPERNAM    Personal name formatted improperly. Returns
                       an FAO argument containing the improperly
                       formatted personal name.
    MAIL$_ILLSUBDIR    Illegal subdirectory specification. Returns
                       an FAO argument containing the subdirectory
                       string.
    MAIL$_INVITMCOD    The specified item code is invalid.
    MAIL$_INVITMLEN    The specified item length is invalid.
    MAIL$_MISREQITEM   The required item is missing.
    MAIL$_NAMTOOBIG    Specified name exceeds 255-character limit.
    MAIL$_NOTSUBDIR    No such subdirectory. Returns an FAO argument
                       containing the subdirectory string.
    MAIL$_NOSUCHUSR    No such user. Returns the name of the unfound
                       user.
    MAIL$_NOSYSNAM     Caller needs SYSNAM privileges.
    MAIL$_NOSYSPRV     Caller needs system privileges.
    SS$_ACCVIO         Access violation.