Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / GetCurrentFolder Method


In This Topic
    GetCurrentFolder Method
    In This Topic
    Retrieves the current working folder of the FTP server.
    Syntax
    'Declaration
 
Public Function GetCurrentFolder() As String
    'Usage
 
Dim instance As FtpClient
Dim value As String
 
value = instance.GetCurrentFolder()
    public string GetCurrentFolder()

    Return Value

    A string representing the FTP server's current folder. The path returned is an absolute path that can be used with the ChangeCurrentFolder to go directly to this folder regardless of the current working folder.
    Exceptions
    ExceptionDescription
    FtpInvalidStateExceptionCannot perform the requested operation because the FTP client is in an invalid state.
    FtpReplyExceptionAn error reply was returned by the FTP server.
    FtpIOExceptionAn I/O error has occurred.
    FtpInternalExceptionA fatal FTP-specific error has occurred..
    Remarks

    The FTP server's current working folder is used by the FTP server as the base folder from which to perform file operations such as obtaining folder contents, receiving, sending and deleting files, changing the current folder, etc. It can be changed using the ChangeCurrentFolder and ChangeToParentFolder methods.

    The GetCurrentFolder method will send the PWD command to the FTP server.

    This method is the equivalent of the CurrentFolder property of the ActiveX version of the Xceed FTP Library.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    FtpClient Class
    FtpClient Members
    ChangeToParentFolder Method
    Xceed.Ftp.FtpClient.ChangeCurrentFolder(Xceed.Ftp.Engine.FtpCommandChannel,Xceed.Ftp.Engine.ChangeFolderFtpCommand)

    Send Feedback