CreatePortOverlappedEx Method

Creates virtual serial port with non-standard name over existing COM port and allows replacing the value of FriendlyName and CompanyName (indicated by the license key) with alternative values.

Custom license key is needed to unlock this method. Otherwise it fails.

Syntax

Visual Basic .NET
Sub CreatePortOverlappedEx(ByVal PortName As String, ByVal Alias As String, ByVal FriendlyName As String, ByVal CompanyName As String) 
Visual C#
void CreatePortOverlappedEx(String PortName, String Alias, String FriendlyName, String CompanyName);

Parameters

PortName

[in] The name of virtual serial port (e.g. "COM1", "VSP25", "SERPORT10" etc). Names "COM0", "COM4294967295" and "LPTx" are prohibited.

Alias

[in] Alias name for existing COM port. You still will be able to open existing COM port using this alias name. The string is an MS-DOS path (e.g. PORT1, COM100).

FriendlyName

[in] FriendlyName Value. If NULL – the value integrated into the license key is used. Can be set only if any FriendlyName is integrated into the license key, otherwise it fails with ftvspcErrorInvalidLicense error.

CompanyName

[in] Company name. If NULL - the value integrated into the license key is used. Can be set only if any FriendlyName is integrated into the key, otherwise it fails with ftvspcErrorInvalidLicense error.

Return

TRUE - the port has been created successfully, FALSE otherwise.

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.
ftvspcErrorInvalidLicense 5 Invalid license.
ftvspcErrorPortAlreadyExists 100 This port already exists.
ftvspcErrorNoSuchPort 101 Physical port does not exists.

Remarks

Overlapped port will be created only if physical port with specified name exists. Otherwise, ftvspcErrorNoSuchPort error will be returned.