Open Method—ArcGIS Pro

Connects to a new device location source such as a GPS/GNSS device via a COM port. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void Open( 
   DeviceLocationSource source,
   DeviceLocationProperties props
)

Public Sub Open( _
   ByVal source As DeviceLocationSource, _
   Optional ByVal props As DeviceLocationProperties _
)

Parameters

source: A DeviceLocationSource.
props: A DeviceLocationProperties.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	Value cannot be null: source
System.ArgumentException	DeviceLocationSource ComPort cannot be null

Remarks

At a minimum, a ComPort must be specified in the DeviceLocationSource parameter.

Example

var sp = new SerialPortDeviceLocationSource()
{
  ComPort = "COM4",
};
            
await QueuedTask.Run(() =>
{
  DeviceLocationService.Instance.Open(sp);
});

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

DeviceLocationService Class
DeviceLocationService Members