Xceed .NET Libraries Documentation
Xceed.Ftp Assembly / Xceed.Ftp Namespace / FtpClient Class / Timeout Property


In This Topic
    Timeout Property (FtpClient)
    In This Topic
    Gets or sets a value, in seconds, indicating after what period of time an FTP operation should timeout.
    Syntax
    'Declaration
     
    Public Property Timeout As Integer
    'Usage
     
    Dim instance As FtpClient
    Dim value As Integer
     
    instance.Timeout = value
     
    value = instance.Timeout
    public int Timeout {get; set;}

    Property Value

    A value, in seconds, representing the period of time after which an FTP operation should timeout. By default, this property is set to 30 seconds.
    Remarks

    During a file transfer, the timeout value doesn't specify the time it must take for the file to be completely transferred. Rather, it specifies the maximum amount of time one iteration of the internal copy loop can take.

    One iteration of the copy loop consists of the following:

    • Read data from the local source file stream
    • Trigger the FtpClient.FileTransferStatus event, if applicable
    • Write the data to the destination network stream
    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