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 01/01/2000 and 12//31/2099.

There might be as much as a 1 minute delay after the passage of the specified time. This specification could be changed in the future.

If a time that has already past is specified for the alarm, the notification is made 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/09/18
Added restrictions on times for which alarm can be set.
2010/08/16
Initial version.

CONFIDENTIAL