PowerTCP Mail for .NET
Response Property
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > InvokeEventArgs Class : Response Property




Gets the response received from the server.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property Response As Response
Visual Basic (Usage)Copy Code
Dim instance As InvokeEventArgs
Dim value As Response
 
value = instance.Response
C# 
public Response Response {get;}
Managed Extensions for C++ 
public: __property Response* get_Response();
C++/CLI 
public:
property Response^ Response {
   Response^ get();
}

Property Value

A Response object representing the response received from the server.

Example

The following example demonstrates using Ftp.BeginInvoke to issue a command (in this case, CDUP) asynchronously.
Visual BasicCopy Code
' Set server and user properties. This will allow calling of other
' Ftp Component methods with the log in taking place "behind the scenes"
Ftp1.Server = "MyFTPServer"
Ftp1.Username = "blah"
Ftp1.Password = "mypass"


' Issue CDUP command asynchronously, upon completion the EndInvoke Event will be fired.
Ftp1.BeginInvoke(Dart.PowerTCP.Ftp.FtpCommand.ChangeDirUp, Nothing, Nothing)

' Report
Debug.WriteLine("CDUP command sent.")

' When the BeginInvoke operation has completed, the EndInvoke Event will fire.
Private Sub Ftp1_EndInvoke(ByVal sender As Object, ByVal e As Dart.PowerTCP.Ftp.InvokeEventArgs) Handles Ftp1.EndInvoke

   ' If an error occurred during the asynchronous method, it would 
   ' be returned in the event. Be sure to check for it.
   If e.Exception Is Nothing Then
      Debug.WriteLine("Command issued " + e.Request)
      Debug.WriteLine("Response received " + e.Response.ToString();
   Else
      Debug.WriteLine(e.Exception.Message)
   End If
   
   ' Close the connection
   Ftp1.Close()
End Sub
C#Copy Code
// Set server and user properties. This will allow calling of other
// Ftp Component methods with the log in taking place "behind the scenes"
ftp1.Server = "MyFTPServer";
ftp1.Username = "blah";
ftp1.Password = "mypass";


// Issue CDUP command asynchronously, upon completion the EndInvoke Event will be fired.
ftp1.BeginInvoke(Dart.PowerTCP.Ftp.FtpCommand.ChangeDirUp, null, null);

// Report
Debug.WriteLine("CDUP command sent.");

// When the BeginInvoke operation has completed, the EndInvoke Event will fire.
private void ftp1_EndInvoke(object sender, Dart.PowerTCP.Ftp.InvokeEventArgs e)
{

    // If an error occurred during the asynchronous method, it would 
    // be returned in the event. Be sure to check for it.
    if(e.Exception == null)
    {
        Debug.WriteLine("Command issued " + e.Request);
        Debug.WriteLine("Response received " + e.Response);
    }
    else
    {
        Debug.WriteLine("Error: " + e.Exception.Message);
    }

    // Close the connection
    ftp1.Close();
}

Remarks

The response to a command is encapsulated by the InvokeEventArgs.Response property, which allows easy access to the code (through the InvokeEventArgs.Code property) and text (through the InvokeEventArgs.Text property) portions of the response without parsing. If you wish to have to entire, unparsed response from the server, simply use the Response.ToString method.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 3.2
© 2010 Dart Communications. All Rights Reserved.