TElSimpleSftpClient.OpenFile method

Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.OpenFile

TElSimpleSFTPClient See also

Filter: C# VB.NET Pascal C++ PHP Java

Opens a file on the server.

Declaration

[C#]
byte[] OpenFile(string Filename, TSBSftpFileOpenModes Modes, TElSftpFileAttributes Attributes);
byte[] OpenFile(string Filename, TSBSftpFileOpenModes Modes, TSBSftpFileOpenAccess Access, TElSftpFileAttributes Attributes);

[VB.NET]
Function OpenFile(ByVal Filename As String, ByVal Modes As TSBSftpFileOpenModes, ByVal Attributes As TElSftpFileAttributes) As Byte()
Function OpenFile(ByVal Filename As String, ByVal Modes As TSBSftpFileOpenModes, ByVal Access As TSBSftpFileOpenAccess, ByVal Attributes As TElSftpFileAttributes) As Byte()

[Pascal]
function OpenFile(const Filename : string; Modes : TSBSftpFileOpenModes; Attributes : TElSftpFileAttributes) : TSBSftpFileHandle; overload;
function OpenFile(const Filename : string; Modes : TSBSftpFileOpenModes; Access : TSBSftpFileOpenAccess; Attributes : TElSftpFileAttributes) : TSBSftpFileHandle; overload;

[C++]
    void OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TElSftpFileAttributes &Attributes, std::vector<uint8_t> &OutResult);
    void OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TElSftpFileAttributes *Attributes, std::vector<uint8_t> &OutResult);
    void OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TSBSftpFileOpenAccess Access, TElSftpFileAttributes &Attributes, std::vector<uint8_t> &OutResult);
    void OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TSBSftpFileOpenAccess Access, TElSftpFileAttributes *Attributes, std::vector<uint8_t> &OutResult);

[PHP]
string OpenFile(string $Filename, integer $Modes, TElSftpFileAttributes $Attributes)
string OpenFile(string $Filename, integer $Modes, integer $Access, TElSftpFileAttributes $Attributes)

[Java]
byte[] openFile(String Filename, TSBSftpFileOpenModes Modes, TElSftpFileAttributes Attributes);
byte[] openFile(String Filename, TSBSftpFileOpenModes Modes, TSBSftpFileOpenAccess Access, TElSftpFileAttributes Attributes);

Parameters

Filename - the name of the file to be opened.
Modes - specifies the file opening modes.
Attributes - specifies the initial attributes for the file.
Access - specifies if file must be blocked for reading, writing, or deleting while opened.

TSBSftpFileOpenAccess values

[.NET][C++]	[Pascal]	[PHP]	Description
f_faReadLock = 1	faReadLock	faReadLock = 1	...
f_faWriteLock = 2	faWriteLock	faWriteLock = 2	...
f_faDeleteLock = 4	faDeleteLock	faDeleteLock = 4	...
f_faBlockAdvisory = 8	faBlockAdvisory	faBlockAdvisory = 8	...

TSBSftpFileOpenModes values

[.NET][C++]	[Pascal]	[PHP]	Description
f_fmRead = 1	fmRead	fmRead = 1	...
f_fmWrite = 2	fmWrite	fmWrite = 2	...
f_fmAppend = 4	fmAppend	fmAppend = 4	...
f_sfmCreate = 8	sfmCreate	sfmCreate = 8	...
f_fmTruncate = 16	fmTruncate	fmTruncate = 16	...
f_fmExcl = 32	fmExcl	fmExcl = 32	...
f_fmText = 64	fmText	fmText = 64	...
f_fmOpenOrCreate = 128	fmOpenOrCreate	fmOpenOrCreate = 128	...
f_fmAppendAtomic = 256	fmAppendAtomic	fmAppendAtomic = 256	...
f_fmNoFollow = 512	fmNoFollow	fmNoFollow = 512	...
f_fmDeleteOnClose = 1024	fmDeleteOnClose	fmDeleteOnClose = 1024	...

TSBSftpFileOpenAccess values

[.NET][C++]	[Pascal]	[PHP]	Description
f_faReadLock = 1	faReadLock	faReadLock = 1	...
f_faWriteLock = 2	faWriteLock	faWriteLock = 2	...
f_faDeleteLock = 4	faDeleteLock	faDeleteLock = 4	...
f_faBlockAdvisory = 8	faBlockAdvisory	faBlockAdvisory = 8	...

Return value

Returns handle to the opened file.

Description

    Use this method to open files on a server side.
    In case of error, EElSFTPError exception containing SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.

    The file is opened in binary mode, unless fmText flag is included to Modes parameter.

After you have finished using the directory, close the handle with a call to CloseHandle() method.

Note, the Access parameter has sense only for SFTPv5 and will be ignored for earlier versions.
Note, setting of file opening mode differs for VCL and .NET versions. To enable several modes in .NET use bitwise OR operation, for example "fmRead | fmWrite | fmAppend".

See also: CloseHandle CreateFile OpenStream RemoveFile Read Write

Discuss this help topic in SecureBlackbox Forum