Topic Path: Symbol Reference > Classes > TIdStack Class > TIdStack Methods > Receive Method
ContentsIndexHome
PreviousUpNext
TIdStack.Receive Method

Receives data from the remote connected on a socket handle.

function Receive(
    ASocket: TIdStackSocketHandle; 
    var VBuffer: TIdBytes
): Integer; virtual; abstract;
Parameters 
Description 
ASocket 
Socket handle for the operation.
 
ABuffer 
Buffer used to store values read from the socket handle. 

Integer - Number of bytes read from the socket handle.

Receive is an abstract virtual Integer function that specifies the method used to access the Recv() API for a protocol stack implementation. 

ASocket is the socket handle to use for reading values from the remote connection. If no incoming data is available on the socket handle, Receive will block and wait for data to arrive or a timeout to occur. 

The return value for the method can included the following values under the associated conditions: 

 

Bytes 
Condition 
Connection has closed gracefully 
>0 
Number of bytes receive on the socket handle. 

 

Other situations will result in raising an Exception pertinent to the error.

Receive does not make any provision for sending flags as arguments to the Recv() API. The flags parameter can be used to influence the behavior of the function invocation beyond the options specified for the associated socket.

Copyright 1993-2006, Chad Z. Hower (aka Kudzu) and the Indy Pit Crew. All rights reserved.
Post feedback to the Indy Docs Newsgroup.