WaitFor(String) Method

Reads data from the stream until the specified string is found.

[Visual Basic]
Overloads Public Function WaitFor( _
   ByVal prompt As String _
) As String

[C#]
public string WaitFor( 
   string prompt
);

[C++]
public: string* WaitFor( 
   string* prompt
) 

[C++/CLI]
public:
String^ WaitFor( 
   String^ prompt
) 

Parameters

prompt

Data is read until this string is found.

Return Type

A string containing all data read from the stream.

Exceptions

Remarks

This method reads from the data stream until the specified string is found or the method times out. Often, it is useful when communicating with a server to be able to read data until a token is found. For example, during a login operation the server may send a string "login:". You could use WaitFor to keep reading until you find "login:", then issue your login command.

This method will block for the amount of time specified in Tcp.ReceiveTimeout. If Tcp.ReceiveTimeout is 0, this method will throw a System.InvalidOperationException. If prompt is not found within the time specified by Tcp.ReceiveTimeout, a System.SocketException is thrown (with the timeout ErrorCode of 10060).

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

Tcp Class  | Tcp Members  | Overload List