RecordedSound.RequestUploadToFTP method

RecordedSound.RequestUploadToFTP method

Remarks

Requests to start an uploading session of the recorded sound to a FTP server.

An uploading session can be terminated before completion through a call to the RecordedSound.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.

For further details about recorded sound methods refer to the RecordedSound class section.

For further details see the How to perform a recording session section.

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

Syntax

[Visual Basic]

Public Function RequestUploadToFTP (

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

string strHost,

string strUsername,

string strPassword,

Int32 nPort,

bool bPassiveMode,

string strDirectory,

string strFilename

);

[C++]

public: enumErrorCodes RequestUploadToFTP (

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	Numeric value	Meaning
BOOL_FALSE	0	Don't use passive mode
BOOL_TRUE	1	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.

Return to Table of contents