Website Download Support
 

Discuss this help topic in SecureBlackbox Forum

TElSftpClient.OpenStream

TElSftpClient     See also     

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

Opens a stream access to the remote file.

Declaration

[C#]
    TElSftpStream OpenStream(string Filename, TSBSftpFileOpenModes Modes);

[VB.NET]
    Function OpenStream(ByVal Filename As String, ByVal Modes As TSBSftpFileOpenModes) As TElSftpStream

[Pascal]
    function OpenStream(const Filename : string; Modes : TSBSftpFileOpenModes) : TElSftpStream;
    
    TSBSftpFileOpenModes = set of TSBSftpFileOpenMode;

[C++]
    TElSftpStreamHandle OpenStream(const std::string &Filename, TSBSftpFileOpenModes Modes);

[PHP]
    TElSftpStream OpenStream(string $Filename, integer $Modes)

[Java]
    TElSftpStream openStream(String Filename, TSBSftpFileOpenModes Modes);

Parameters

  • Filename - the name of the file to be opened.
  • Modes - specifies the file opening modes.

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)

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

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

    Returns a reference to the newly created SFTP stream object.

Description

    Use this method to open remote access to a file using stream interface. Note, that call to this method sets SFTPClient into synchronous for the time of all TElSftpStream methods execution.
   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:     OpenFile    

Discuss this help topic in SecureBlackbox Forum

Copyright (c) 2018, /n software, inc.