View source for TWSocket.ReceiveStr

[[Main_Page | Main page]] -> [[ICS_Components_Reference | ICS component reference]] -> [[TWSocket]] -> [[TWSocket.ReceiveStr | ReceiveStr]]

== Definition ==

 '''function''' ReceiveStr: '''string''';

== Description ==

'''ReceiveStr''' is used (mainly in [[TWSocket.OnDataAvailable|OnDataAvailable]] if the component is set to use [[TWSocket.LineMode|LineMode]]. It receives the next complete line which has been sent to the attached IP/port. ReceiveStr returns the whole line sent, including the delimiter characters set via [[TWSocket.LineEnd|LineEnd]].

== Example ==

  procedure TMySocket.MyOnDataAvailable(Sender: TObject; ErrCode: Word);
  var s    :String; // received packet
  begin
    if ErrCode <> 0 then
    begin
      exit;
    end;
  
    s:=ReceiveStr;
  end;

== Best practices ==
* always set [[TWSocket.LineLimit|LineLimit]]

== How to ==