TElSftpClient.OpenFile method

Discuss this help topic in SecureBlackbox Forum

TElSftpClient.OpenFile

TElSftpClient See also

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

Opens a file on the server.

Declaration

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

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

[Pascal]
    function OpenFile(Filename : string; Modes : TSBSftpFileOpenModes; Attributes : TElSftpFileAttributes) : boolean;
    function OpenFile(const Filename : string; Modes : TSBSftpFileOpenModes; Access : TSBSftpFileOpenAccess; Attributes : TElSftpFileAttributes): boolean;
    function OpenFileSync(const Filename : string; Modes : TSBSftpFileOpenModes; Attributes : TElSftpFileAttributes) : TSBSftpFileHandle;
    function OpenFileSync(const Filename : string; Modes : TSBSftpFileOpenModes; Access : TSBSftpFileOpenAccess; Attributes : TElSftpFileAttributes) : TSBSftpFileHandle;
    type TSBSftpFileHandle = ByteArray;
    TSBSftpFileOpenModes = set of TSBSftpFileOpenMode;
    TSBSftpFileOpenAccess = set of TSBSftpFileOpenAccessItem;

[C++]
    bool OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TElSftpFileAttributes &Attributes);
    bool OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TElSftpFileAttributes *Attributes);
    bool OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TSBSftpFileOpenAccess Access, TElSftpFileAttributes &Attributes);
    bool OpenFile(const std::string &Filename, TSBSftpFileOpenModes Modes, TSBSftpFileOpenAccess Access, TElSftpFileAttributes *Attributes);

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

[Java]
boolean openFile(String Filename, TSBSftpFileOpenModes Modes, TSBSftpFileOpenAccess Access, TElSftpFileAttributes Attributes);
boolean openFile(String Filename, TSBSftpFileOpenModes Modes, 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.

TSBSftpFileOpenMode values:

[.NET]	[Pascal]	[C++]	Description
fmRead = 1	fmRead	f_fmRead = 1	Open file for reading
fmWrite = 2	fmWrite	f_fmWrite = 2	Open file for writing
fmAppend = 4	fmAppend	f_fmAppend = 4	Data is always written at the end of the file
fmCreate = 8	fmCreate	f_fmCreate = 8	New file is created; if the file already exists, operation will fail
fmTruncate = 16	fmTruncate	f_fmTruncate = 16	A new file is created; if the file already exists, it is opened and truncated
fmExcl = 32	fmExcl	f_fmExcl = 32	Specifies exclusive file opening mode.In this mode only one thread is allowed to access the file at a time,and if another process will try to open the file, an exception will be raised
fmText = 64	fmText	f_fmText = 64	Indicates that the file will be opened as text andconverted to the canonical newline convention in use
fmOpenOrCreate = 128	fmOpenOrCreate	f_fmOpenOrCreate = 128	If the file exists, it will be opened.If the file does not exist, it will be created
fmAppendAtomic = 256	fmAppendAtomic	f_fmAppendAtomic = 256	Data will be always written at the end of the file,and data will be written atomically so that there is no chance thatmultiple appenders can collide and result in data being lost
fmNoFollow = 512	fmNoFollow	f_fmNoFollow = 256	If the final component of the path is a symlink, then the open will fail
fmDeleteOnClose = 1024	fmDeleteOnClose	f_fmDeleteOnClose = 1024	The file will be deleted when the last handle to it is closed.(The last handle may not be an sftp-handle)

TSBSftpFileOpenAccessItem values:

[.NET]	[Pascal]	[C++]	Description
faReadLock = 1	faReadLock	f_faReadLock = 1	No other handle has been opened for reading andno other handle will be opened for reading until the client closes the handle.However other handle can be opened for any other access but reading
faWriteLock = 2	faWriteLock	f_faWriteLock = 2	No other handle has been opened for writing or appending andno other handle will be opened for writing or appending until the client closes the handle.However other handle can be opened for any other access but writing or appending
faDeleteLock = 4	faDeleteLock	f_faDeleteLock = 4	No other handle has been opened for deleting or with delete on close flag andno other handle will be opened deleting or with delete on close flag until the client closes the handle
faBlockAdvisory = 8	faBlockAdvisory	f_faBlockAdvisory = 8	If this bit is set, the above block modes are advisory.In advisory mode, only other accesses that specify a block mode need to be consideredwhen determining whether the block access can be granted

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Return value

OpenFile returns True if the operation was completed successfully, and False otherwise.
OpenFileSync returns a handle to the opened file.

Description

Use OpenFile to open files on a server side in asynchronous mode, and OpenFileSync to open files in synchronous mode. If the file was successfully opened, the OnOpenFile event is fired. The OnError event is fired otherwise.

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