- 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
FtVspcGetErrorMessage Function
Retrieves the error code description.
size_t FtVspcGetErrorMessage( FtVspc_ErrorCode error, LPTSTR lpBuffer, size_t cchBuffer );
Parameters
error
[in] Error code. Refer to FtVspc_ErrorCode.
lpBuffer
[in] A pointer to the buffer that receives the null-terminated string containing the error code description.
cchBuffer
[in] Maximum size of the buffer specified by the lpBuffer parameter, in TCHARs.
Return Value
If the function succeeds, the return value is the length of the string copied to the buffer, in TCHARs, not including the terminating null character. If the length is greater than the size of the buffer, the return value is the size of the buffer required to hold the message (including the terminating null character). If the function fails, the return value is zero.
Remarks
ANSI version is available for Win32 only.