System.Win.ScktComp.TCustomWinSocket.ReceiveText

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function ReceiveText: AnsiString;

C++

System::AnsiString __fastcall ReceiveText();

Properties

Type Visibility Source Unit Parent
function public
System.Win.ScktComp.pas
System.Win.ScktComp.hpp
System.Win.ScktComp TCustomWinSocket

Description

Reads a string from the socket connection.

Use ReceiveText to read a string from the socket connection in the OnSocketEvent event handler of a Windows socket object or in the OnRead or OnClientRead event handler of a socket component. ReceiveText returns the string that was read.

ReceiveText only works in response to a read notification to a non-blocking windows socket. Blocking sockets must use a TWinSocketStream for reading. The TWinSocketStream object waits for the remote socket to be ready before transferring information.

See Also