SetupComm

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

At a Glance

Syntax

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

Parameters

hFile

[in] Handle to the communications device. The CreateFile function returns this handle.

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 Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

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

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.

See Also

CreateFile, SetCommState

SetUrlCacheEntryGroup

This function adds or removes entries from a cache group.

At a Glance

Syntax

BOOL SetUrlCacheEntryGroup (LPCSTR lpszUrlName,
DWORD dwFlags, GROUPID GroupId, LPBYTE pbGroupAttributes, DWORD cbGroupAttributes, LPVOID lpReserved);

Parameters

lpszUrlName

[in] Address of a string value that contains the URL of the cached resource.

dwFlags

[in] Unsigned long integer value that determines whether the entry is added to or removed from a cache group. Can be one of the following values:

GroupId

[in] GROUPID value that indicates the cache group that the entry will be added to or removed from.

pbGroupAttributes

[in] Reserved. Must be set to NULL.

cbGroupAttributes

[in] Reserved. Must be set to zero.

lpReserved

[in] Reserved. Must be set to NULL.

Return Values

Returns TRUE if successful, or FALSE otherwise.

Remarks

A cache entry can belong to more than one cache group.