The
Virtual Serial Port (VSP) API Programmers Guide and Reference
describes in detail the programming interface of the VSP. The
following table of contents demonstrates the level of technical
detail presented. Click here to download
this manual in PDF format.
1. Introduction 3
1.1 What’s in This Manual 3
1.2 Audience 3
1.3 Limitations 3
2. Communications Resources in Windows 4
3. Binding the VSP API to Your Application 6
3.1 Introduction – C++ Class form vs. ANSI C form 6
3.2 Name Decoration in C++ (“mangling”) vs. ANSI C
6
3.3 Source Code Include ( “VspApi.h” ) 6
3.4 The “VspApi.dll” File 6
3.5 Binding “VspApi.lib” File 7
4. VSP API Reference (C++ Class Form) 8
4.1 Overview of the VSP API 8
4.2 The cVspApi Class 8
4.2.1 Constructor / Destructors 8
4.2.2 Open ( ) Function of cVspApi 9
4.2.3 Close ( ) Function of cVspApi 10
4.2.4 Read ( ) Function of cVspApi 11
4.2.5 Write ( ) Function of cVspApi 12
4.2.6 GetBufferStatus ( ) Function of cVspApi 13
4.2.7 GetVirtualModemControlLines ( ) Function of cVspApi 14
4.2.8 GetOpenCount ( ) Function of cVspApi 15
4.2.9 AddSerialPort ( ) Function of cVspApi 16
4.2.10 DeleteSerialPort ( ) Function of cVspApi 17
4.2.11 IsVirtualPort ( ) Function of cVspApi 18
4.2.12 WaitForChanges ( ) Function of cVspApi 19
4.2.13 SetVirtualModemStatusLines ( ) Function of cVspApi 21
4.2.14 SetDeviceOptions ( ) Function of cVspApi 22
4.2.15 GetDcb ( ) Function of cVspApi 23
4.2.16 DllVersion ( ) Function of cVspApi 24
4.2.17 DriverVersion ( ) Function of cVspApi 25
4.2.18 SetTimeouts ( ) Function of cVspApi 26
4.2.19 VSP_TIMEOUTS Structure used by cVspApi 27
4.2.20 SetReadFileTiming ( ) Function of cVspApi 29
4.2.21 GetReadFileTiming ( ) Function of cVspApi 30
4.2.22 SetWriteFileTiming ( ) Function of cVspApi 31
4.2.23 GetWriteFileTiming ( ) Function of cVspApi 32
4.2.24 VSP_RW_FILE_TIMING Structure used by cVspApi 33
4.2.25 VSP_TIMEOUTS Structure used by cVspApi 34
5. VSP API Reference (ANSI C Form) 36
5.1 Overview 36
5.2 Parameter Usage 36
5.3 Function Enumeration 37
5.4 Linker Symbol Names 39
6. WIN32 Communications Interfaces of the VSP 40
6.1 Overview of the WIN32 Communications API 40
6.2 The DCB Structure 41
7. Index of Acronyms and Abbreviations 46
