FtVspcCreatePortOverlappedEx Function

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 function. Otherwise it fails.

BOOL FtVspcCreatePortOverlappedEx(
	LPCTSTR lpszPortName,
	LPCTSTR lpszRealPortAlias,
	LPCTSTR lpszFriendlyName,
	LPCTSTR lpszCompanyName 
	);

Parameters

lpszPortName

[in] The name of virtual serial port (e.g. "COM1", "VSP25", "SERPORT10" etc). Names "COM0", "COM4294967295" and "LPTx" are prohibited.
It is recommended to use FtVspcCreatePortOverlappedByNum function for creating virtual serial ports with custom names (e.g. COMx).

lpszRealPortAlias

[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).

lpszFriendlyName

[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.

lpszCompanyName

[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 Value

If the function succeeds, the return value is TRUE. Otherwise, use FtVspcGetLastError to get the error code (FtVspc_ErrorCode).

Errors

Remarks

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