tfFtpNewSession

Jump to: navigation, search

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


#include <trsocket.h>


ttUserFtpHandle tfFtpNewSession (
int fileSystemFlags,
int blockingState,
char * fsUsernamePtr,
char * fsPasswordPtr
);


Function Description

This function creates a new FTP client session. This session may be used for multiple consecutive connections to multiple servers. This call returns a handle that should be used for all future commands associated with this session. When the session is complete, the user should call tfFtpFreeSession() to free the resources used by this session. The user can specify whether this session should be blocking or non-blocking by setting 'blockingState' accordingly (TM_BLOCKING_ON and TM_BLOCKING_OFF, respectively).


Parameters

  • fileSystemsFlags
    Flags to be passed to the local file system when it is opened.
  • blockingState
    Specifies the blocking mode: TM_BLOCKING_ON or TM_BLOCKING_OFF.
  • fsUsernamePtr
    A pointer to the username used to logon to the local file system.
  • fsPasswordPtr
    A pointer to the password used to logon to the local file system.


Returns

  • NULL
    Error creating the new FTP session.
  • Other ttUserFtpHandle
    The ttUserFtpHandle associated with the newly created FTP session.


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