System.Net.Socket.TSocketStream.Read

• Up to Parent: TSocketStream

Delphi

function Read(var Buffer; Count: LongInt): LongInt; overload; override;

C++

virtual System::LongInt __fastcall Read(void *Buffer, System::LongInt Count)/* overload */;
inline System::LongInt __fastcall  Read(System::Sysutils::TBytes Buffer, System::LongInt Offset, System::LongInt Count){ return System::Classes::TStream::Read(Buffer, Offset, Count); }
inline System::LongInt __fastcall  Read(System::Sysutils::TBytes &Buffer, System::LongInt Count){ return System::Classes::TStream::Read(Buffer, Count); }

Properties

Type	Visibility	Source	Unit	Parent
function	public	System.Net.Socket.pas System.Net.Socket.hpp	System.Net.Socket	TSocketStream

Description

Obtains data sent from the connected endpoint of the socket that yous specified when you created your socket stream.

Read accepts the following parameters:

• Buf is a pointer to the buffer to receive the incoming data.
• Count is the length (in bytes) of the buffer pointed by Buf, which is also the maximum length of the requested data that Read returns.

Exceptions

A call to Read can raise any of the following exceptions:

Exception	Exception.Message	Scenarios
ESocketError	Network socket error: <error message> (<error code>), on API 'ioctlsocket'	The operating system reported an error while reading the length of the received data. This may happen if you provide -1 as the value of Count or if you provide the Bytes parameter in your call. For more information, see the following documentation for the operating system where your application was running: Windows: ioctlsocket function (MSDN) OS X: ioctl (OS X Man Pages) iOS: ioctl (iOS Manual Pages) Android: ioctl (Linux Programmer's Manual)
	Network socket error: <error message> (<error code>), on API 'recv'	The operating system reported an error while receiving data from your socket. This may happen if you provide a value other than -1 as the value of Count. For more information, see the following documentation for the operating system where your application was running: Windows: recv function (MSDN) OS X: recv (OS X Man Pages) iOS: recv (iOS Manual Pages) Android: recv (Linux Programmer's Manual)

See Also

• System.Net.Socket.TSocketStream.Create

• System.Net.Socket.TSocket
• System.Net.Socket.TSocket.Accept
• System.Net.Socket.TSocket.Receive

• System.Net.Socket.TSocketStream.Write