Copyright © 2008-2018 MultiMedia Soft

RequestUploadSessionToFTP method

Previous pageReturn to chapter overviewNext page

Remarks

 

Requests to start an uploading session of the current editing session to a FTP server.

In case you should need to upload a file stored inside the local hard disk you could use the RequestUploadFileToFTP method.

 

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

 

A successful call to this method will fire the SoundUploadStarted event. Once the upload has been performed completely, the control will fire the SoundUploadDone event. During the uploading session the container application is notified about the advancement percentage through the SoundUploadPerc method.

 

An example of use of this method can be found inside the UploadSoundToFTP sample.

 

 

Syntax

 

[Visual Basic]

Public Function RequestUploadSessionToFTP (

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 RequestUploadSessionToFTP (

string strHost,

string strUsername,

string strPassword,

Int32 nPort,

bool bPassiveMode,

string strDirectory,

string strFilename

);


 

[C++]

public: enumErrorCodes RequestUploadSessionToFTP (

string strHost,

string strUsername,

string strPassword,

Int32 nPort,

bool bPassiveMode,

string strDirectory,

string strFilename

);


 

 

Parameter

Description

 

 

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.