PortHandle Property
Returns a Win32 (long integer) handle to the communications port.
Syntax
Visual Basic
object.PortHandle
Visual C++
object.GetPortHandle()
| Part
| Description |
| object |
An object expression that evaluates to a GPS ToolKit object. |
Example
Visual Basic
Dim handle As Long
'Get the port handle
handle = myGPSToolKit.PortHandle
Visual C++
_variant_t vtPortHandle;
// Get the port handle
vtPortHandle = m_myGPSToolKit.GetPortHandle();
Remarks
This handle may be used when it is necessary to call a Win32
function directly.
Returns
A VARIANT (VT_I4/long) containing the Win32 long integer handle to the communications port.
Errors
Reading the PortHandle property while the port is closed is not permitted
and will cause GPS ToolKit to throw a "Port is closed" exception.
See Also
PortName
|
