KsGetCommProperties

The availability of this function depends on what the device supports.

Retrieves information about the communications properties for a specified communications device.

Syntax

BOOL KsGetCommProperties(
     HANDLE hFile,
     LPCOMMPROP lpCommProp
);

Parameters

hFile: a handle to the communications device. The KsCreateComm function returns this handle.

lpCommProp: a pointer to a COMMPROP structure in which the communications properties information is returned. This information can be used in subsequent calls to the KsSetCommState, KsSetCommTimeouts, or KsSetupComm function to configure the communications device.

Return value

If the function succeeds, it returns TRUE, otherwise FALSE. To get extended error information, call GetLastError.

Example

N/A

Requirements

	RT	Win32
Minimum supported version	4.0	4.0
Header	kscom.h	kscom.h
Library	KsApi_Rtss.lib	ksapi.h