Copyright © 2008-2018 MultiMedia Soft

RequestUploadFileToFTP 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.

 

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.

 

 

Syntax

 

[Visual Basic]

control.RequestUploadFileToFTP (

strInputPathname as String,

strHost as String,

strUsername as String,

strPassword as String,

nPort as Long,

bPassiveMode as enumBoolean,

strDirectory as String,

strFilename as String

) as enumErrorCodes


 

[C++]

short control.RequestUploadFileToFTP (

LPCTSTR strInputPathname,

LPCTSTR strHost,

LPCTSTR strUsername,

LPCTSTR strPassword,

long nPort,

short bPassiveMode,

LPCTSTR strDirectory,

LPCTSTR 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

strUsername

String representing the FTP account username

strPassword

String representing the FTP account password

nPort

FTP port number

bPassiveMode

Boolean value for FTP "passive mode" flag.

Supported values are the following:

Mnemonic Value

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 error code meaning

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.