NWC24SetMsgIconNewSign

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24SetMsgIconNewSign( NWC24MsgObj* obj, BOOL enable );

Description

Specifies to a message whether a new arrival should be indicated using a channel icon in Wii Menu.
When in the Inbox there exists a message for which the setting has been enabled by this function, a layout to indicate a new arrival is displayed with a channel icon when Wii Menu starts. Using this feature, it is possible to notify the user of the arrival of a new message before an application is started.

Caution:

This feature is supported in Wii Menu version 3.0 and higher. This is simply ignored in prior versions.
The only messages for which it is possible to specify a new arrival indication with a channel icon are messages that are to be sent to an application, which are of type NWC24_MSGTYPE_WII_APP or NWC24_MSGTYPE_WII_APP_HIDDEN.
There is no effect if a new arrival indication layout has not been provided for the channel icon. Refer to the IconBannerTools manual for methods to set the new arrival indication layout.
For a message that uses this setting, the new arrival indication will be preserved until the message is deleted from the Inbox.

Arguments

`obj`	Pointer to the message object to be set.
`enable`	Setting to enable and disable new arrival indication with a channel icon (disabled by default).

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_PROTECTED: Cannot change message object.
NWC24_ERR_NOT_SUPPORTED: The message format in which the new arrival indication setting is not available.

Revision History

2007/07/26 Initial version.