NWC24ReadMsgToAddr

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24ReadMsgToAddr(
    const NWC24MsgObj* obj,
    u32                index,
    char*              buffer,
    u32                bufSize
);

Description

Reads one message recipient address from the message data.
The actual message data must be opened and the recipient information string extracted, because it is not included in the message object itself.

This function is valid only for messages exchanged with standard e-mail addresses.

The string to be retrieved is terminated with '\0' (NULL character).

Arguments

`obj`	Message object from which settings are to be extracted.
`index`	Specifies one among multiple recipients.
`buffer`	Pointer to the region where the read string is stored.
`bufSize`	Size of the region specified by `buffer`.

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_PROTECTED: Message object cannot be read.
NWC24_ERR_NOT_SUPPORTED: Unsupported message object specified for obj.
NWC24_ERR_NOT_FOUND: The value specified for index is greater than or equal to the number of recipients set for the message object.
NWC24_ERR_NULL: Message data not set.
NWC24_ERR_OVERFLOW: Recipient addresses set for the message object overflowed the buffer.
NWC24_ERR_FILE_*: Internal file operation error.

Revision History

2006/10/06 Updated return value list.
2006/08/01 Initial version.