Events.Alarm.GetProximity
-------------------------

Queries proximity.

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

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

**MBS**( **"Events.Alarm.GetProximity";** /\* Queries proximity. \*/  
**$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 proximity.  
Defines whether this alarm triggers via entering/exiting a geofence as defined by structuredLocation.  
### Examples

Query proximity:

 MBS ( "Events.Alarm.GetProximity"; "56001" )  
### See also

- [Events.Alarm.SetProximity](EventsAlarmSetProximity.md)

This function checks for a license.

Created 10th March 2016 , last changed 9th November 2021

  
[Events.Alarm.GetEmailAddress](EventsAlarmGetEmailAddress.md) - [Events.Alarm.GetRelativeOffset](EventsAlarmGetRelativeOffset.md)

[HTML Version](EventsAlarmGetProximity.shtml)