FtpClient.BeginGetNameListing Method (AsyncCallback, Object)

System.Net.FtpClient

Collapse image Expand Image Copy image CopyHover image
Asynchronously gets a list of file and directory names for the specified path.

Namespace: System.Net.FtpClient
Assembly: System.Net.FtpClient (in System.Net.FtpClient.dll) Version: 1.0.5064.17461

Syntax

C#
public IAsyncResult BeginGetNameListing(
	AsyncCallback callback,
	Object state
)
Visual Basic
Public Function BeginGetNameListing ( 
	callback As AsyncCallback,
	state As Object
) As IAsyncResult
Visual C++
public:
virtual IAsyncResult^ BeginGetNameListing(
	AsyncCallback^ callback, 
	Object^ state
) sealed

Parameters

callback
Type: System..::..AsyncCallback
Async Callback
state
Type: System..::..Object
State object

Return Value

Type: IAsyncResult
IAsyncResult

Implements

IFtpClient..::..BeginGetNameListing(AsyncCallback, Object)

Examples

C#  Copy imageCopy
using System;
using System.Net;
using System.Net.FtpClient;
using System.Threading;

namespace Examples {
    public static class BeginGetNameListingExample {
        static ManualResetEvent m_reset = new ManualResetEvent(false);

        public static void BeginGetNameListing() {
            using (FtpClient conn = new FtpClient()) {
                m_reset.Reset();

                conn.Host = "localhost";
                conn.Credentials = new NetworkCredential("ftptest", "ftptest");
                conn.BeginGetNameListing(new AsyncCallback(EndGetNameListing), conn);

                m_reset.WaitOne();
                conn.Disconnect();
            }
        }

        static void EndGetNameListing(IAsyncResult ar) {
            FtpClient conn = ar.AsyncState as FtpClient;

            try {
                if (conn == null)
                    throw new InvalidOperationException("The FtpControlConnection object is null!");

                foreach (string s in conn.EndGetNameListing(ar)) {
                    // load some information about the object
                    // returned from the listing...
                    bool isDirectory = conn.DirectoryExists(s);
                    DateTime modify = conn.GetModifiedTime(s);
                    long size = isDirectory ? 0 : conn.GetFileSize(s);
                }
            }
            catch (Exception ex) {
                Console.WriteLine(ex.ToString());
            }
            finally {
                m_reset.Set();
            }
        }
    }
}

See Also