tfFtpSetTimeout

Jump to: navigation, search

Table of Contents >> Application Reference >> FTP Client API


#include <trsocket.h>


int tfFtpSetTimeout (
ttUserFtpHandle ftpUserHandle,
int timeoutName,
int timeoutValue
);


Function Description

This function sets the timeout values for the given FTP session. The default value for all timeouts is 90 seconds.


Parameters

  • ftpUserHandle
    The FTP session handle.
  • timeoutName
    The name of the timeout to modify. This must be one of the following:
  • TM_FTP_TIMEOUT_FLAG_CONNECT
  • TM_FTP_TIMEOUT_FLAG_REPLY
  • TM_FTP_TIMEOUT_FLAG_ACCEPT
  • TM_FTP_TIMEOUT_FLAG_RECV
  • TM_FTP_TIMEOUT_FLAG_SEND
  • timeoutValue
    The new timeout value in milliseconds.


Returns

  • TM_ENOERROR
    Success.
  • TM_EINVAL
    Invalid FTP session pointer.
  • TM_EPERM
    Setting the timeout is not permitted because the session is already connected.


Table of Contents >> Application Reference >> FTP Client API