System.Net.Socket.TSocket.ReceiveStringFrom

• Up to Parent: TSocket

Delphi

function ReceiveStringFrom(Flags: TSocketFlags = []): string; overload; inline;
function ReceiveStringFrom(out Endpoint: TNetEndpoint; Flags: TSocketFlags = []): string; overload;

C++

System::UnicodeString __fastcall ReceiveStringFrom(TSocketFlags Flags = TSocketFlags() )/* overload */;
System::UnicodeString __fastcall ReceiveStringFrom(/* out */ TNetEndpoint &Endpoint, TSocketFlags Flags = TSocketFlags() )/* overload */;

Properties

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

Description

Receives a string from either the specified endpoint or the configured endpoint.

In order to use ReceiveStringFrom, the type of your socket must be either TCP or UDP.

ReceiveStringFrom blocks the caller until it returns the requested string.

You may pass ReceiveStringFrom a Flags parameter, which is a set of flags that influence the behavior of ReceiveStringFrom. For more information, see the documentation of the recvfrom function in the MSDN.

The Endpoint parameter receives the source endpoint address when the underlying protocol provides one.

Exceptions

A call to ReceiveStringFrom 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. 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 'recvfrom'	The operating system reported an error while receiving data from your socket. For more information, see the following documentation for the operating system where your application was running: Windows: recvfrom function (MSDN) OS X: recvfrom (OS X Man Pages) iOS: recvfrom (iOS Manual Pages) Android: recvfrom (Linux Programmer's Manual)

See Also

• System.String

• System.Net.Socket.TSocket.SocketType

• System.Net.Socket.TSocket.Receive
• System.Net.Socket.TSocket.ReceiveFrom