Copyright © 2011-2018 MultiMedia Soft

UploadFileToFTP method

Previous pageReturn to chapter overviewNext page

Remarks

 

Requests to start an uploading session of a given file to a FTP server.

This method can be used in place of the RequestUploadSessionToFTP method when you need to upload a generic file instead of the current editing session.

 

An uploading session can be terminated before completion through a call to the CancelUploadToFTP method.

 

During the execution of the upload session the CallbackPercentage delegate is invoked, with the nOperation parameter set to OPERATION_SOUND_UPLOAD_PERC, in order to notify about the percentage of advancement of the upload session.

 

For further details about callback delegates see the How to synchronize the container application with the API tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function UploadFileToFTP (

strInputPathname as String,

strHost as String,

strUsername as String,

strPassword as String,

nPort as Int32,

bPassiveMode as Boolean,

strDirectory as String,

strFilename as String,

) as enumErrorCodes


 

[C#]

public enumErrorCodes UploadFileToFTP (

string strInputPathname,

string strHost,

string strUsername,

string strPassword,

Int32 nPort,

bool bPassiveMode,

string strDirectory,

string strFilename

);


 

[C++]

public: enumErrorCodes UploadFileToFTP (

string strInputPathname,

string strHost,

string strUsername,

string strPassword,

Int32 nPort,

bool bPassiveMode,

string strDirectory,

string strFilename

);


 

 

Parameter

Description

 

 

strInputPathname

Absolute pathname of the file that needs to be uploaded to the FTP site.

strHost

String representing the FTP host address, without the protocol prefix (for example "ftp.multimediasoft.com" instead of "ftp://ftp.multimediasoft.com")

strUsername

String representing the FTP account username

strPassword

String representing the FTP account password

nPort

FTP port number (for example 21)

bPassiveMode

Boolean value for FTP "passive mode" flag.

Supported values are the following:

 

Mnemonic Value

Meaning

false

Don't use passive mode

true

Use passive mode

strDirectory

String representing the destination directory on FTP server

strFilename

String representing the destination filename

 

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred. Check the LastError property value in order to see the last error.

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.