FtVspcCreatePortEx Function

Creates virtual serial port with non-standard name 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 FtVspcCreatePortEx(
	LPCTSTR lpszPortName,
	LPCTSTR lpszFriendlyName,
	LPCTSTR lpszCompanyName 
	);

Parameters

lpszPortName

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

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

ftvspcErrorFailed 1 The operation has not been completed.
ftvspcErrorInvalidParameter 2 Invalid parameter.
ftvspcErrorInvalidLicense 5 Invalid license.
ftvspcErrorPortAlreadyExists 100 This port already exists.

See Also

FtVspcCreatePort