COM_Read (Windows CE 3.0 Device Driver Developement)

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.

This function enables an application to receive characters from the serial port.

ULONG COM_Read(
HANDLE
pContext
,
PUCHAR
pTargetBuffer
,
ULONG
BufferLength
,
PULONG
pBytesRead
);

Parameters

pContext

Pointer to a handle returned by the COM_Openfunction.

pTargetBuffer

Pointer to valid memory.

BufferLength

Specifies the size, in bytes, of pTargetBuffer.

pBytesRead

Pointer to a ULONG containing the number of bytes read .

Return Values

The number of bytes read indicates success. A value of -1 indicates failure.

Remarks

This function sets the buffer and buffer length requested by the caller. It writes the number of bytes transacted and returns the status of the call.

This function is exported to users through the ReadFilefunction.

This function must obey time-out values set for the serial port.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Mdd.c

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

COM_Write

Last updated on Tuesday, July 13, 2004