NWC24SetMsgLedPattern

Syntax

#include <revolution/nwc24.h>

NWC24Err NWC24SetMsgLedPattern( NWC24MsgObj* obj, u16 pattern );

Description

Embeds a specification in the message for lighting the LED upon arrival. When a message configured using this function is received by the other player's Wii console, it will cause the other Wii's slot to light in the specified pattern.

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.
If a console is running the Wii Menu version 3.0 or earlier (the versions that do not support this feature), the LED will not light for messages that the local Wii console has placed directly in its own inbox.

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/12/21 Revised terminology.
2007/11/07 Changed the note for messages sent to the local inbox to match present specifications.
2007/05/24 Revised macro names.
2007/05/03 Changed the pattern number specification into a macro.
2007/03/27 Added restrictions on the message type to the Caution section.
2007/01/29 Added a link to NWC24EnableLedNotification.
2006/12/05 Initial version.