NWC24SetMsgLedPattern

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24SetMsgLedPattern( NWC24MsgObj* obj, u16 pattern );

Description

Embeds a specification in the message for lighting the LED upon arrival. Messages configured using this function cause the slot LED on the console to light according to the specified pattern when the message is received by the other player's Wii console.

Caution:

The only messages in which this LED specification can be set are messages of type NWC24_MSGTYPE_WII_MENU or NWC24_MSGTYPE_WII_MENU_SHARED that are to be sent to the Wii Message Board.
The LED will not light on consoles where the LED light feature has been turned off.
The LED does not light when a message is received while running an application in which lighting LED is prohibited with NWC24EnableLedNotification.
Sometimes the LED will not light, depending on the time at which the message is received.
The LED does not light for messages directly output to one's own inbox for consoles running version 3.0 or earlier of Wii Menu.

Arguments

`obj`	Pointer to the message object to be set.
`pattern`	The lighting pattern number. (The only pattern number currently usable is the value defined as `NWC24_LED_APP_DEFAULT`. Operations are not guaranteed if any other number is specified.)

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_PROTECTED: Cannot change message object.
NWC24_ERR_INVALID_VALUE: Invalid value specified for pattern.
NWC24_ERR_NOT_SUPPORTED: LED light specification uses an unsupported message format.

Revision History

2007/11/07 Changed the caution specific to messages output to own inbox in conjunction with present specifications.
2007/05/24 Revised the macro name
2007/05/03 Changed the macro to specify a pattern number
2007/03/27 Added message type restrictions to the Caution section
2007/01/29 Added link to NWC24EnableLedNotification
2006/12/05 Initial version.