NWC24SetMsgMBDelay

Syntax

#include <revolution/nwc24.h>
NWC24Err NWC24SetMsgMBDelay( NWC24MsgObj* obj, u8 delayHours );

Description

Specifies the amount of time to hide the message sent to the local Wii Message Board before actually showing it to users.

The Wii Message Board will not get the message until the time specified by this function has passed since the creation of the message. Until that time, the message stays in the Inbox. During that time, if the message itself is deleted, its registration to the Wii Message Board will be cancelled as well. The message will take the real time of the calendar when it becomes displayable and registered to the calendar.

Note: In version 3.0 and earlier of the Wii Menu, we determined that display may actually be suppressed for several hours more than the value that was set. Thus, if you cannot determine the version of the Wii menu, you should specify at least 24 hours for delayHours and avoid planning anything that depends on this feature for measuring time.

In addition, this function cannot be used for messages sent to other Wii console's message boards. The same functionality is available through the use of NWC24SetMsgDesignatedTime.

The date and time set using the Wii console settings cannot be used to determine the passage of time. Therefore, even though the time of the console settings has advanced for the amount of time the display was not displayed, there may be cases where it may not be displayed.

Arguments

obj Pointer to the message object to be set.
delayHours Time with no display (in units of hours)
Minimum: 24 (recommended), Maximum: 255

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_PROTECTED: Cannot change the message object.
NWC24_ERR_NOT_SUPPORTED: A message type other than that used by the Wii Message Board is specified for obj, or an attempt was made to send a message to another Wii console over the network.

See Also

NWC24InitMsgObj NWC24SetMsgDesignatedTime

Revision History

2007/11/08 Prohibited use when sending to another Wii console.
2007/09/19 Added notes and a description of the range of values.
2007/04/03 Added more information on the timing of message reception by the Wii Message Board.
2006/10/06 Initial version.


CONFIDENTIAL