nn::ptm::CTR::SetRtcAlarm Function

Syntax

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

Arguments

Name Description
in datetime Specifies an alarm time

Return Values

Returns the result of setting the alarm.

Description

Sets an alarm.

Specify the time you want the alarm to send notification; when that time comes, the event that was registered by 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 been configured already, the function returns nn::ptm::ResultAlarmOverWrite. The alarm is set successfully even in this case.

Revision History

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.

CONFIDENTIAL