Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function initializes the communications parameters for a specified communications device.

Syntax 

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

Parameters

hFile

[in] Handle to the communications device returned by the CreateFilefunction.

dwInQueue

[in] Specifies the recommended size, in bytes, of the device's internal input buffer.

dwOutQueue

[in] Specifies the recommended size, in bytes, of the device's internal output buffer.

Return Value

Always returns FALSE because the FIFO queue size cannot be changed. To obtain extended error information, call GetLastError.

Remarks

After a process uses the CreateFilefunction to open a handle to a communications device, it can call SetupCommto 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.

  1. The dwInQueueand dwOutQueueparameters 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.

The device driver receives the recommended buffer sizes, but is free to use any 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.

Requirements

Header winbase.h
Library Serdev.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also