NWC24SetMsgToAddr

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24SetMsgToAddr( NWC24MsgObj* obj, const char* addr, u32 length );

Description

Specifies a message recipient with a string.
Although a total of eight recipients may be set, when there are multiple recipients, NWC24SetMsgToAddr() is called once for each recipient.
This function is valid only for objects that have been initialized as general e-mail messages.

The buffer given by the addr argument is not freed until NWC24CommitMsg() is called and creation of the message is complete.

Arguments

`obj`	Pointer to the message object to be set.
`addr`	Pointer to the user's e-mail address string to add as a recipient.
`length`	Length of the string specified by `addr`.

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_PROTECTED: Message object cannot be changed.
NWC24_ERR_NULL: The addr argument is a null pointer, or the e-mail address text string is empty.
NWC24_ERR_NOT_SUPPORTED: Unsupported message object specified by obj.
NWC24_ERR_FULL: Addresses have already been specified up to the limit.
NWC24_ERR_OVERFLOW: The length argument specification is over the limit.
NWC24_ERR_STRING_END: The addr argument is not null-terminated.

Revision History

2006/11/13 Added a description of how to handle the buffer.
2006/10/06 Updated the return value list.
2006/08/01 Initial version.