SalQuickFTP

Namespace: PPJ.Runtime.Windows.QO

Assembly: PPJ.Runtime.49 (4.9.0.0)

FTP Control.

C#

public class SalQuickFTP : SalCustomControl

VB.NET

Public Class SalQuickFTP
    Inherits SalCustomControl

Constructors

SalQuickFTP()

Default Constructor.

Properties

AppName

String: invalid (Default: "")

FtpClient

SalFtpClient: Returns the single instance of the FTP client. It is created when it's needed.

Password

String: (Default: "")

ServerName

String: invalid (Default: "")

ServerPort

Int32: invalid (Default: 21)

UserName

String: invalid (Default: "")

WindowsClassName

String: invalid (Default: "")

WindowsDLLName

String: invalid (Default: "")

WindowsExStyle

Int32: invalid (Default: 0)

WindowsStyle

Int32: invalid (Default: 0)

Methods

CloseFile(hFile)

Closes an open file.

Parameter	Type	Description
hFile	SalNumber

Returns: SalNumber.

Connect(sServerName, nServerPort, sUserName, sPassword)

Establish communication with an FTP server under the user and password specified. If the user name is null, the anonymous user is connected.

Parameter	Type	Description
sServerName	SalString
nServerPort	SalNumber
sUserName	SalString
sPassword	SalString

Returns: SalNumber.

CreateDirectory(sDirectory)

Creates a directory on the FTP server.

Parameter	Type	Description
sDirectory	SalString

Returns: SalNumber.

DeleteFile(sRemoteFile)

Deletes the specified file on the FTP server.

Parameter	Type	Description
sRemoteFile	SalString

Returns: SalNumber.

Disconnect()

Disconnects the current connection.

Returns: SalNumber.

EnumDirectories(sSearch, sDirs)

Obtain an array of directory names based on a search path specified.

Parameter	Type	Description
sSearch	SalString
sDirs	SalArray<SalString>

Returns: SalNumber.

EnumFiles(sSearchFile, saFileNames)

Parameter	Type	Description
sSearchFile	SalString
saFileNames	SalArray`1&

Returns: SalNumber.

EnumFilesInfo(sSearchFile, saFileNames, naAttributes, dtaCreationTimes, dtaLastAccessTimes, dtaLastWriteTimes, naFileSizes)

Obtain an array of file names and all related file information based on a search path specified.

Parameter	Type	Description
sSearchFile	SalString
saFileNames	SalArray<SalString>
naAttributes	SalArray<SalNumber>
dtaCreationTimes	SalArray<SalDateTime>
dtaLastAccessTimes	SalArray<SalDateTime>
dtaLastWriteTimes	SalArray<SalDateTime>
naFileSizes	SalArray<SalNumber>

Returns: SalNumber.

FindFirstFile(sSearchFile, sFileName)

Parameter	Type	Description
sSearchFile	SalString
sFileName	SalString&

Returns: SalNumber.

FindFirstFileInfo(sSearchFile, sFileName, nAttributes, dtCreationTime, dtLastAccessTime, dtLastWriteTime, nFileSize)

Parameter	Type	Description
sSearchFile	SalString
sFileName	SalString&
nAttributes	SalNumber&
dtCreationTime	SalDateTime&
dtLastAccessTime	SalDateTime&
dtLastWriteTime	SalDateTime&
nFileSize	SalNumber&

Returns: SalNumber.

FindNextFile(sFileName)

Parameter	Type	Description
sFileName	SalString&

Returns: SalNumber.

FindNextFileInfo(sFileName, nAttributes, dtCreationTime, dtLastAccessTime, dtLastWriteTime, nFileSize)

Parameter	Type	Description
sFileName	SalString&
nAttributes	SalNumber&
dtCreationTime	SalDateTime&
dtLastAccessTime	SalDateTime&
dtLastWriteTime	SalDateTime&
nFileSize	SalNumber&

Returns: SalNumber.

GetCurrentDirectory(sDirectory)

Parameter	Type	Description
sDirectory	SalString&

Returns: SalNumber.

GetFile(sRemoteFile, sLocalFile, bTransferBinary, nContext)

Copies a file from an FTP server to the local machine. If nContext is greater than zero, an asynchronous process is started and status messages are send to the window. The nContext argument uniquely identifies the asynchronous process and is passed into the status messages in wParam.

Parameter	Type	Description
sRemoteFile	SalString
sLocalFile	SalString
bTransferBinary	SalBoolean
nContext	SalNumber

Returns: SalNumber.

GetLastErrorCode()

Returns the code of the last error that was handled by the class.

Returns: SalNumber.

GetLastErrorMessage()

Returns the message of the last error that was handled by the class.

Returns: SalString.

OpenFile(sRemoteFile, nFlags, bFlags)

Opens a file on an FTP server.

Parameter	Type	Description
sRemoteFile	SalString
nFlags	SalNumber
bFlags	SalBoolean

Returns: SalNumber.

PutFile(sLocalFile, sRemoteFile, bBinaryTransfer, nContext)

Copies a file from a local machine to an FTP server. If nContext is greater than zero, an asynchronous process is started and status messages are sent to the window. The nContext argument uniquely identifies the asynchronous process and is passed into the status messages through wParam.

Parameter	Type	Description
sLocalFile	SalString
sRemoteFile	SalString
bBinaryTransfer	SalBoolean
nContext	SalNumber

Returns: SalNumber.

ReadFile(hFile, sBuffer, nBufferSize)

Parameter	Type	Description
hFile	SalNumber
sBuffer	SalString&
nBufferSize	SalNumber

Returns: SalNumber.

RemoveDirectory(sDirectory)

Delete a specified directory on an FTP server.

Parameter	Type	Description
sDirectory	SalString

Returns: SalNumber.

RenameFile(sOldRemoteFile, sNewRemoteFile)

Rename a file on an FTP server.

Parameter	Type	Description
sOldRemoteFile	SalString
sNewRemoteFile	SalString

Returns: SalNumber.

SetCurrentDirectory(sDirectory)

Changes to a different working directory on an FTP server.

Parameter	Type	Description
sDirectory	SalString

Returns: SalNumber.

WriteFile(hFile, sBuffer, nBufferSize)

Writes information to an open file on an FTP server.

Parameter	Type	Description
hFile	SalNumber
sBuffer	SalString
nBufferSize	SalNumber

Returns: SalNumber.

Implements

Name	Description
ISalWindow	All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.