Website Download Support
 

Discuss this help topic in SecureBlackbox Forum

TElCustomFileSystemAdapter.GetFileStream

TElCustomFileSystemAdapter     See also     

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

Retrieves a stream associated with the specified file.

Declaration

[C#]
    int GetFileStream(string Path, uint OpenMode, TSBFileShareMode ShareMode, ref System.IO.Stream FileStream);

[VB.NET]
    Function GetFileStream(ByVal Path As String, ByVal OpenMode As UInt32, ByVal ShareMode As TSBFileShareMode, ByRef FileStream As System.IO.Stream) As Integer

[Pascal]
    function GetFileStream(const Path : string; OpenMode : cardinal; ShareMode : TSBFileShareMode; var FileStream : TStream) : integer; virtual; abstract;

[C++]
    int32_t GetFileStream(const std::string &Path, uint32_t OpenMode, TSBFileShareMode ShareMode, TStream &FileStream);

[PHP]
    integer GetFileStream(string $Path, integer $OpenMode, integer $ShareMode, TStream &$FileStream)

[Java]
    int getFileStream(String arg0, int arg1, TSBFileShareMode arg2, TElVFSOutputFileStream arg3);

Parameters

  • Path - path to the file.
  • OpenMode - specifies file open mode.
  • ShareMode - specifies shared access mode.
  • FileStream - the stream associated with the specified file.

Possible open modes:

[.NET] [Pascal] [C++] Description
fileOpenRead = 1 SB_fileOpenRead = 1 File is opened for reading
fileOpenWrite = 2 SB_fileOpenWrite = 2 File is opened for writing
fileOpenCreate = 4 SB_fileOpenCreate = 4 If file does not exists, it will be created
fileOpenAppend = 8 SB_fileOpenAppend = 8 The information will be written to the end of the opened file
fileOpenTruncate = 16 SB_fileOpenTruncate = 16 Truncate the file on opening

Possible share modes:

[.NET] [C++] [Pascal] Description
ssmExclusive = 0 ssmExclusive Defines exclusive access.
ssmDenyRead = 1 ssmDenyRead Reading is denied.
ssmDenyWrite = 2 ssmDenyWrite Writing is denied.
ssmNone = 3 ssmNone No sharing at all.

Return value

    Returns a VFS error code.

Possible values:

Definition Value Description
ERROR_FACILITY_VFS 102400 (0x19000) Base error code for VFS errors
ERROR_VFS_ERROR_FLAG 1024 (0x0400) VFS error flag
ERROR_VFS_CUSTOM_ERROR_FLAG 2048 (0x0800) VFS custom error flag
SB_VFS_ERROR_FILE_NOT_FOUND 103426 (0x19402) File not found
SB_VFS_ERROR_PATH_NOT_FOUND 103427 (0x19403) Path not found
SB_VFS_ERROR_ACCESS_DENIED 103429 (0x19405) Access denied
SB_VFS_ERROR_WRITE_PROTECT 103443 (0x19413) The file is write-protected
SB_VFS_ERROR_ERROR_CRC 103447 (0x19417) CRC error
SB_VFS_ERROR_NOT_SUPPORTED 103474 (0x19432) Operation not supported
SB_VFS_ERROR_INVALID_PARAMETER 103511 (0x19457) Invalid parameter encountered when accessing directory entries
SB_VFS_ERROR_NO_MEDIA 104536 (0x19858) Storage media is not accessible
SB_VFS_UNSPECIFIED_ERROR 104448 (0x19800) Any unspecified error

Description

    Use this method to get access to the file using stream interface.

See also:     FileOpen    

Discuss this help topic in SecureBlackbox Forum

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