HELPLIB.HLB  —  MAIL Routines, MAIL$SEND_ADD_ADDRESS
    Adds an address to the address list. If an address list does not
    exist, MAIL$SEND_ADD_ADDRESS creates one.

    Format

      MAIL$SEND_ADD_ADDRESS  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
    Send context information to be passed to send routines. The
    context argument is the address of a longword that contains send
    context information returned by MAIL$SEND_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 is terminated by longword value of 0.

3  –  Input Item Codes

 MAIL$_SEND_USERNAME

    MAIL$_SEND_USERNAME specifies that the Mail utility add a
    specified user name to the address list. The buffer address
    field of the item descriptor points to a buffer that receives
    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 item code MAIL$_SEND_USERNAME is required.

 MAIL$_SEND_USERNAME_TYPE

    MAIL$_SEND_USERNAME_TYPE specifies the type of user name added to
    the address list. The buffer address field of the item descriptor
    points to a word that contains the user name type.

    There are two types of user names, as follows:

    o  User name specified as a To: address (default)

    o  User name specified as a CC: address

                                   NOTE

       Currently, the symbols MAIL$_TO and MAIL$_CC define user
       name types.

 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

    If you do not specify a MAIL$_SEND_USERNAME_TYPE, MAIL$SEND_ADD_
    ADDRESS uses MAIL$_TO. You can specify only one user name per
    call to MAIL$SEND_ADD_ADDRESS.

6  –  Condition Values Returned

    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 values returned by LIB$TPARSE.
Close Help