- Overview
DLL API Reference
- Getting Started
Functions
- FtVspcApiClose Function
- FtVspcApiInit Function
- FtVspcApplyKey Function
- FtVspcEnumPhysical Function
- FtVspcEnumVirtual Function
- FtVspcGetPhysical Function
- FtVspcGetPhysicalNum Function
- FtVspcGetVirtual Function
- FtVspcGetVirtualNum Function
- FtVspcCreatePort Function
- FtVspcCreatePortEx Function
- FtVspcCreatePortByNum Function
- FtVspcCreatePortOverlapped Function
- FtVspcCreatePortOverlappedEx Function
- FtVspcCreatePortOverlappedByNum Function
- FtVspcCreateTwinPort Function
- FtVspcCreateTwinPortEx Function
- FtVspcCreateTwinPortByNum Function
- FtVspcRemovePort Function
- FtVspcRemovePortByNum Function
- FtVspcAttach Function
- FtVspcAttachByNum Function
- FtVspcDetach Function
- FtVspcGetPermanent Function
- FtVspcGetPermanentByNum Function
- FtVspcGetPortType Function
- FtVspcGetPortTypeByNum Function
- FtVspcGetQueryOpen Function
- FtVspcGetQueryOpenByNum Function
- FtVspcSetPermanent Function
- FtVspcSetPermanentByNum Function
- FtVspcSetQueryOpen Function
- FtVspcSetQueryOpenByNum Function
- FtVspcRead Function
- FtVspcWrite Function
- FtVspcGetBitrateEmulation Function
- FtVspcGetBreak Function
- FtVspcGetCts Function
- FtVspcGetDcd Function
- FtVspcGetDsr Function
- FtVspcGetFraming Function
- FtVspcGetInQueueBytes Function
- FtVspcGetOverrun Function
- FtVspcGetParity Function
- FtVspcGetRing Function
- FtVspcSetBitrateEmulation Function
- FtVspcSetBreak Function
- FtVspcSetCts Function
- FtVspcSetDcd Function
- FtVspcSetDsr Function
- FtVspcSetFraming Function
- FtVspcSetOverrun Function
- FtVspcSetParity Function
- FtVspcSetRing Function
- FtVspcGetErrorMessage Function
- FtVspcGetInfo Function
- FtVspcGetLastError Function
ActiveX Component Reference
- Getting Started
FTVSPCControl Class
FTVSPCPort Class
- FTVSPCPort Class description
Events
- OnBreak Event
- OnClose Event
- OnOpen Event
- OnOpenBeforeAttach Event
- OnPurge Event
- OnQueryOpen Event
- OnRxChar Event
- OnBaudRate Event
- OnDataBits Event
- OnParity Event
- OnStopBits Event
- OnTimeouts Event
- OnDtr Event
- OnRts Event
- OnBreakChar Event
- OnEofChar Event
- OnErrorChar Event
- OnEvtChar Event
- OnXoffChar Event
- OnXoffLim Event
- OnXonChar Event
- OnXonLim Event
- OnAbortOnError Event
- OnDsrSensitivity Event
- OnDtrControl Event
- OnInX Event
- OnNull Event
- OnOutX Event
- OnOutxCtsFlow Event
- OnOutxDsrFlow Event
- OnRtsControl Event
- OnTXContinueOnXoff Event
- OnUseErrorChar Event
.NET Component Reference
- Getting Started
FTVSPCControl Class
FTVSPCPort Class
- FTVSPCPort Class description
Events
- OnBreak Event
- OnClose Event
- OnOpen Event
- OnOpenBeforeAttach Event
- OnPurge Event
- OnQueryOpen Event
- OnRxChar Event
- OnBaudRate Event
- OnDataBits Event
- OnParity Event
- OnStopBits Event
- OnTimeouts Event
- OnDtr Event
- OnRts Event
- OnBreakChar Event
- OnEofChar Event
- OnErrorChar Event
- OnEvtChar Event
- OnXoffChar Event
- OnXoffLim Event
- OnXonChar Event
- OnXonLim Event
- OnAbortOnError Event
- OnDsrSensitivity Event
- OnDtrControl Event
- OnInX Event
- OnNull Event
- OnOutX Event
- OnOutxCtsFlow Event
- OnOutxDsrFlow Event
- OnRtsControl Event
- OnTXContinueOnXoff Event
- OnUseErrorChar Event
GetPhysical Method
Retrieves the name of physical serial port by index.
Syntax
| Visual Basic .NET | Function GetPhysical(ByVal Index As UInt32) As String |
|---|---|
| Visual C# | String GetPhysical(UInt32 Index); |
Parameters
Index
[in] Index of physical serial port (0 ... unPortsCount - 1). Refer to EnumPhysical.
Return
Returns the number of physical serial port by index.
Errors
The method may throw exception. Use GetLastError method to get the error code.
| ftvspcErrorFailed | 1 | The operation has not been completed. |
|---|---|---|
| ftvspcErrorInvalidParameter | 2 | Invalid parameter. |
| ftvspcErrorInsufficientBuffer | 4 | Insufficient buffer size. |
| ftvspcErrorNoMoreItems | 102 | There is no item (possible reason: index is too high). |
Remarks
You must call EnumPhysical before calling this function.