FtVspcGetPhysicalNum Function

Retrieves the number of physical serial port by index.

BOOL FtVspcGetPhysicalNum(
	UINT unIndex,
	UINT* lpunPortNo 
	);

Parameters

unIndex

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

lpunPortNo

[out] A pointer to the variable where the number of physical serial port is returned (e.g 1 means COM1, 5 means COM5 and so on). If the number is -1, it means that the port name differs from "COMx" and the name should be retrieved by FtVspcGetPhysical.

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.
ftvspcErrorNoMoreItems 102 There is no item (possible reason: index is too high).

Remarks

You must call FtVspcEnumPhysical before calling this function.

See Also

FtVspcEnumPhysical, FtVspcGetPhysical