1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 3<HEAD> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META http-equiv="Content-Style-Type" content="text/css"> 6<TITLE>NWC24SetMsgToAddr</TITLE> 7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css"> 8</HEAD> 9<BODY> 10<H1>NWC24SetMsgToAddr</H1> 11 12<H2>C Specification</H2> 13<DL> 14<DD><PRE><CODE>#include <revolution/nwc24.h></CODE></PRE> 15<DD><PRE><CODE><A HREF="../Types/NWC24Err.html">NWC24Err</A> NWC24SetMsgToAddr( <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>, const char* <EM>addr</EM>, u32 <EM>length</EM> );</CODE></PRE> 16</DL> 17 18<H2>Description</H2> 19<P> 20Specifies a message recipient with a string.<BR>Although a total of eight recipients may be set, when there are multiple recipients, <CODE>NWC24SetMsgToAddr()</CODE> is called once for each recipient.<BR>This function is valid only for objects that have been initialized as general e-mail messages. 21</P> 22 23<P> 24The buffer given by the <CODE><EM><STRONG>addr</STRONG></EM></CODE> argument is not freed until <A HREF="NWC24CommitMsg.html"><CODE>NWC24CommitMsg()</CODE></A> is called and creation of the message is complete. 25</P> 26 27<H2>Arguments</H2> 28<TABLE border="1" cellpadding="3" cellspacing="0.1"> 29 <TR> 30<TD width="120" bgcolor="#ffffe8"><code><em><strong>obj</strong></em></code></TD> 31 <TD width="520"> 32Pointer to the message object to be set. 33 </TD> 34 </TR> 35 <TR> 36<TD width="120" bgcolor="#ffffe8"><code><em><strong>addr</strong></em></code></TD> 37 <TD width="520"> 38Pointer to the user's e-mail address string to add as a recipient. 39 </TD> 40 </TR> 41 <TR> 42<TD width="120" bgcolor="#ffffe8"><code><em><strong>length</strong></em></code></TD> 43 <TD width="520"> 44Length of the string specified by <code><em><strong>addr</strong></em></code>. 45 </TD> 46 </TR> 47</TABLE> 48 49<h2>Return Values</h2> 50<P> 51<code>NWC24_OK</code>: Normal exit.<BR> <code>NWC24_ERR_PROTECTED</code>: Message object cannot be changed.<BR> <code>NWC24_ERR_NULL</code>: The <code><em><strong>addr</strong></em></code> argument is a null pointer, or the e-mail address text string is empty.<BR> <code>NWC24_ERR_NOT_SUPPORTED</code>: Unsupported message object specified by <code><em><strong>obj</strong></em></code>.<BR> <code>NWC24_ERR_FULL</code>: Addresses have already been specified up to the limit.<BR> <code>NWC24_ERR_OVERFLOW</code>: The <code><em><strong>length</strong></em></code> argument specification is over the limit.<BR> <code>NWC24_ERR_STRING_END</code>: The <code><em><strong>addr</strong></em></code> argument is not null-terminated.<BR> 52</P> 53 54<H2>See Also</H2> 55<P> 56<A href="NWC24InitMsgObj.html"><CODE>NWC24InitMsgObj</CODE></A>, <A href="NWC24SetMsgToId.html"><CODE>NWC24SetMsgToId</CODE></A> 57</P> 58 59<H2>Revision History</H2> 60<P> 612006/11/13 Added a description of how to handle the buffer.<BR> 2006/10/06 Updated the return value list.<BR> 2006/08/01 Initial version. 62</P> 63 64<hr><p>CONFIDENTIAL</p></body> 65</HTML>