PortName Property

Returns the name of the port ("COM1", "COM2", etc.).

Syntax

[Visual Basic]
object.PortName

[C#]
object.PortName

[C++]
object->PortName

Parameters

object

An object expression that evaluates to a GPSToolKit object.

Return Value

A string containing the name of the open port.

Remarks

None

Errors

Reading the PortName property while the port is closed is not permitted and will cause GPS ToolKit.NET to throw a PortClosedException.

Example

[Visual Basic]
Dim portName As string
portName = myGPSToolKit.PortName


[C#]
string portName = myGPSToolKit.PortName;


[C++]
string* portName = myGPSToolKit->PortName;

See Also