nn::ptm::CTR::SetRtcAlarm Function

Result SetRtcAlarm(
     nn::fnd::DateTime datetime
);

	Name	Description
in	datetime	Specifies an alarm time

Returns the function's execution result. Returns one of the Result values listed below.

Value	Description
ResultSuccess	Process was successful.
ResultNotRegistered	The nn::ptm::CTR::RegisterAlarmEvent function has not been called.
ResultInvalidAlarm	The specified date is not in the valid range.
ResultOverWriteAlarm	The alarm has already been set.

Sets an alarm.

Specify the time you want the alarm to send notification; when the specified time passes, the event that was registered by @ref RegisterAlarmEvent is signaled.

You can specify any time between 2000/01/01 and 2099/12/31.

Sometimes, there is as much as a one-minute delay past the specified time before the event is signaled. Alternately, the event is sometimes signaled several seconds (roughly 3 seconds) before the specified time.

If you specify a time that has already passed, the event is signaled immediately.

If the alarm has already been configured, the function returns @ref nn::ptm::ResultOverWriteAlarm. The alarm is set successfully even in this case.

2011/01/19

Revised explanation of return values.

2010/12/03

Added information about alarm accuracy.

2010/09/18

Added restrictions on times for which alarm can be set.

2010/08/16

Initial version.