KsSetupComm

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

Initializes the communications parameters for a specified communications device.

Syntax

BOOL KsSetupComm(
     HANDLE hFile,
     DWORD dwInQueue,
     DWORD dwOutQueue
);

Parameters

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

dwInQueue: the recommended size of the device's internal input buffer, in bytes.

dwOutQueue: the recommended size of the device's internal output buffer, in bytes.

Return value

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

Remarks

After a process uses the KsCreateComm function to open a handle to a communications device, but before doing any I/O with the device, it can call KsSetupComm to set the communications parameters for the device. If it does not set them, the device uses the default parameters when the first call to another communications function occurs.

The dwInQueue and dwOutQueue parameters specify the recommended sizes for the internal buffers used by the driver for the specified device. For example, YMODEM protocol packets are slightly larger than 1024 bytes. Therefore, a recommended buffer size might be 1200 bytes for YMODEM communications. For Ethernet-based communications, a recommended buffer size might be 1600 bytes, which is slightly larger than a single Ethernet frame.

The device driver receives the recommended buffer sizes, but is free to use any input and output (I/O) buffering scheme, as long as it provides reasonable performance and data is not lost due to overrun (except under extreme circumstances). For example, the function can succeed even though the driver does not allocate a buffer, as long as some other portion of the system provides equivalent functionality.

Example

N/A

Requirements

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