nn::ptm::CTR::GetRtcAlarm Function

Syntax

Result GetRtcAlarm(
     nn::fnd::DateTime * pDatetime
);

Arguments

Name Description
out pDatetime Specifies the address where the obtained time should be placed.

Return Values

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

Value Description
Result::IsSuccess Process was successful.
ResultNoAlarm An alarm has not been configured.

Description

Gets the time for which the alarm has been set.

If notification of the time has been sent already, or if an alarm has not been configured, the function returns ResultNoAlarm. In these cases, no value is placed in pDatetime.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL