NWC24SetMsgDesignatedTime

C Specification

#include <revolution/nwc24.h>
NWC24Err NWC24SetMsgDesignatedTime( NWC24MsgObj* obj, s32 elapsedTime );

Description

Specifies the scheduled send time for a message in minutes elapsed from the present.
Normally when a message is placed in the Outbox, it will be sent the first time the automatic send and receive process starts. However, if a scheduled send time has been configured, the message will not be sent until that scheduled time.

Note: This feature only ensures that a message will not be sent sooner than the specified time; it does not ensure that a message will be sent precisely at the specified time. If the console's power is off, the WiiConnect24 scheduler is stopped, or other similar situations occur when the specified time is reached, the actual sending time may be delayed.

Arguments

obj Pointer to the message object to be set.
elapsedTime scheduled send time (number of minutes to elapse from now)
Set a value larger than 0 and equal to or less than 14,400. (14,400 minutes = 10 days.)

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_PROTECTED: Cannot change message object.
NWC24_ERR_INVALID_VALUE: Invalid value specified for elapsedTime.

See Also

NWC24InitMsgObj, NWC24CommitMsg

Revision History

2007/11/5 Added text indicating the maximum value for elapsedTime.
2007/07/26 Initial version.


CONFIDENTIAL