Share via


OEMSetAlarmTime (Compact 2013)

10/16/2014

This function sets the real-time clock (RTC) alarm.

Syntax

BOOL OEMSetAlarmTime(
  LPSYSTEMTIME lpst 
);

Parameters

  • lpst
    [in] Pointer to the buffer containing the alarm time.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

This function must be re-entrant and, thus, must protect the hardware from being accessed multiple times. This function is called by the kernel.

Example

The following code example shows how to make this function re-entrant.

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

BOOL OEMSetAlarmTime( __in LPSYSTEMTIME lpst)
{
    BOOL RetVal;

    EnterCriticalSection(&RTC_critsect);
    RetVal = Bare_SetAlarmTime(lpst);
    LeaveCriticalSection(&RTC_critsect);
    
    return RetVal;
}

Requirements

Header

nkintr.h

Library

OEMMain.lib or OEMMain_StaticKITL.lib

See Also

Reference

Required OAL Functions
OEMGetRealTime
OEMSetRealTime