InetRead
INT InetRead(
SOCKET hSocket,  
LPBYTE lpBuffer,  
INT cbBuffer  
);

The InetRead function reads the specified number of bytes from the socket and copies them into the buffer. The data may be of any type, and is not terminated with a null-byte.

Parameters

hSocket
The socket handle.
lpBuffer
Pointer to the buffer in which the data will be copied.
cbBuffer
The maximum number of bytes to read and copy into the specified buffer. This value must be greater than zero.

Return Value

If the function succeeds, the return value is the number of bytes actually read. A return value of zero indicates that the remote host has closed the connection and there is no more data available to be read. If the function fails, the return value is INET_ERROR. To get extended error information, call InetGetLastError.

Remarks

When InetRead is called and the socket is in non-blocking mode, it is possible that the function will fail because there is no available data to read at that time. This should not be considered a fatal error. Instead, the application should simply wait to receive the next asynchronous notification that data is available.

Requirements

Client: Requires Windows Vista, Windows XP or Windows 2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or Windows 2000 Server.
Header: Include cswsock6.h.
Library: Use cswskav6.lib.

See Also

InetFlush, InetPeek, InetReadEx, InetWrite, InetWriteEx


Copyright © 2008 Catalyst Development Corporation. All rights reserved.