Events.Alarm.GetRelativeOffset
------------------------------

Queries the relative offset from an event start date to fire an alarm.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [Events](component_Events.md) | [6.2](newinversion62.md) | ✅ Yes | ❌ No | ❌ No | ❌ No | ✅ Yes |

MBS( "Events.Alarm.GetRelativeOffset"; EKAlarm ) 

**MBS**( **"Events.Alarm.GetRelativeOffset";** /\* Queries the relative offset from an event start date to fire an alarm. \*/  
**$EKAlarm**) /\* The reference to the alarm.e.g. $Alarm \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| EKAlarm | The reference to the alarm. | $Alarm |

### Result

Returns number or error.

### Description

Queries the relative offset from an event start date to fire an alarm.  
Value is in seconds.  
### Examples

Query relative offset:

 MBS ( "Events.Alarm.GetRelativeOffset"; $alarm )  
### See also

- [Events.Alarm.SetRelativeOffset](EventsAlarmSetRelativeOffset.md)
- [Events.NewAlarmWithRelativeOffset](EventsNewAlarmWithRelativeOffset.md)

This function checks for a license.

Created 10th March 2016 , last changed 10th March 2016

  
[Events.Alarm.GetProximity](EventsAlarmGetProximity.md) - [Events.Alarm.GetSound](EventsAlarmGetSound.md)

[HTML Version](EventsAlarmGetRelativeOffset.shtml)