Printable version
This Page
All Pages
PDF (0.1 MB)

[Index]

Install
Install SDK
Start sample

Samples
C#
VB.NET

Distribution
.NET
SerialTools Distribution

SerialTools Standard - Normal serial port access

If you are using the Port class only, make sure you include SerialNET.dll in the same directory as your EXE file.


SerialTools Pro - Virtual Serial Ports
(SerialTools 2.0 and later)

If you are using the VPort class, that is virtual ports, and possibly also the Port class you got the options below for distribution.

In both cases make sure you include SerialNET.dll in your distribution.

Option 1:
Install SerialTools RunTime for Windows on the target computer (all desktop Windows versions)
Download here

Option 2:
(Windows ME/98, SerialTools 2.01 and later):

Install vfran.vxd under the system directory e.g. C:\Windows\System\
Install FransonRegistryRestoration.exe under the system directory e.g. C:\Windows\
Install SerialXP.dll under the system directory e.g. C:\Windows\System\SerialXP.dll

SerialXP.dll must be registered as a COM/ActiveX component.

(Windows NT/2000/XP/2003):

Custom installation, using InstallShiled or similar
Install bizVSerialNT.sys under in the drivers directory e.g. C:\Windows\System32\Drivers\bizVSerialNT.sys
Install bizVSerialInstallNT.dll to your application root.
Install SerialXP.dll under the system directory e.g. C:\Windows\System32\SerialXP.dll

SerialXP.dll must be registered as a COM/ActiveX component.

Use bizVSerialInstallNT.dll to install (and uninstall the driver). This DLL has 4 exported functions.

LONG WINAPI Install(HWND hwnd, LPSTR szSrcDir, LPSTR szSupport, LPSTR szInst, LPSTR szDbase)
This method follows InstallShileds classic API. You should call this method during installation after bizVSerialNT.sys has been copied to its destination directory.

Here is a typical "Custom Action" you can use in InstallShield to call this method:
Source Location: Browse File System
File Name: ..path on your local developer computer..\bizVSerialInstallNT.dll
Function Name: Install
Function Signature: Classic
Invoke: After File Transfer
Wait for Action: Yes
Run Once: Yes
Execute: During Installation
Ignore Exit Code:No
Comments: 
Condition:Win NT/2k/XP

LONG WINAPI Uninstall(HWND hwnd, LPSTR szSrcDir, LPSTR szSupport, LPSTR szInst, LPSTR szDbase)
This method follows InstallShileds classic API. You should call this method during uninstall before any files have been removed.

Uninstall() will check the reference count for bizVSerialNT.sys under SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDLLs in the registry. If this is the last application using the driver, the driver will be unregistered. It is very importaint that the installation program used supports reference counting of installed files. InstallShiled does, and likewise most installation programs on the market.

Here is a typical "Custom Action" you can use in InstallShield to call this method durin Uninstall:
Source Location:Installed with the product
File Name:[INSTALLDIR]bizVSerialInstallNT.dll
Function Name:Uninstall
Function Signature: Classic
Invoke: Before System Changes
Wait for Action: Yes
Run Once: Yes
Execute: During Uninstallation
Ignore Exit Code:Yes
Comments: 
Condition:Win NT/2k/XP


LONG WINAPI InstallSilent()
Does the same thing as Install() above but takes no parameters and shows no message boxes on errors. Returns an error code on failure and 0 on success.

LONG WINAPI UninstallSilent()
Does the same thing as Uninstall() above but takes no parameters and shows no message boxes on errors. Returns an error code on failure and 0 on success.

UninstallSilent() will check the reference count for bizVSerialNT.sys under SOFTWARE\Microsoft\Windows\CurrentVersion\SharedDLLs in the registry. If this is the last application using the driver, the driver will be unregistered. It is very importaint that the installation program used supports reference counting of installed files. InstallShiled does, and likewise most installation programs on the market.

NOTE! The virtual port driver of SerialTools Pro is the same as used in GpsGate. GpsGate and any number of applications based on SerialTools Pro can exist on the same computer. However there is one limitation. If you uninstall GpsGate 1.10 beta11 (or earlier) the uninstall program will always uninstall the driver. This is fixed in GpsGate 1.10 beta12 and later.

Index

© 2016 Franson Technology AB, All rights reserved, Contact | | Affiliate | Login