FtVspcGetVirtual Function

Retrieves virtual serial port name by index.

BOOL FtVspcGetVirtual(
	UINT unIndex,
	LPTSTR lpPortName,
	size_t cbPortName,
	BOOL* lpbMarkedForDeletion 



[in] Index of virtual serial port (0 ... unPortsCount - 1). Refer to FtVspcEnumVirtual.


[in] A pointer to the variable where the name of virtual serial port is returned.


[in] Size of lpPortName in bytes.


[out] A pointer to the variable where MarkedForDeletion property of virtual serial port is returned. If TRUE, the port is marked for deletion (but it cannot be deleted because it is open by serial application). It will be removed on port close. FALSE otherwise.

Return Value

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


ftvspcErrorFailed 1 The operation has not been completed.
ftvspcErrorInvalidParameter 2 Invalid parameter.
ftvspcErrorInsufficientBuffer 4 Insufficient buffer size.
ftvspcErrorNoMoreItems 102 There is no item (possible reason: index is too high).

See Also

FtVspcEnumVirtual, FtVspcGetVirtualNum