TElCustomFileSystemAdapter.FileWrite method

Discuss this help topic in SecureBlackbox Forum

TElCustomFileSystemAdapter.FileWrite

Writes a block of bytes to the specified file.

Declaration

[C#]
int FileWrite(Object FileHandle, byte[] Buffer, int Index, int Size, ref int ErrorCode);

[VB.NET]
Function FileWrite(ByVal FileHandle As Object, ByVal Buffer As Byte(), ByVal Index As Integer, ByVal Size As Integer, ByRef ErrorCode As Integer) As Integer

[Pascal]
function FileWrite(FileHandle : TObject; Buffer : ByteArray; Index, Size : integer) : integer; virtual; abstract;

[C++]
int32_t FileWrite(TObject &FileHandle, const std::vector<uint8_t> &Buffer, int32_t Index, int32_t Size, int32_t &ErrorCode);
int32_t FileWrite(TObject *FileHandle, const std::vector<uint8_t> &Buffer, int32_t Index, int32_t Size, int32_t &ErrorCode);

[PHP]
integer FileWrite(TObject $FileHandle, array of byte|string|NULL $Buffer, integer $Index, integer $Size, integer &$ErrorCode)

[Java]
int fileWrite(TObject arg0, byte[] arg1, int arg2, int arg3, TSBInteger arg4);

Parameters

FileHandle - the handle to the file where to write the data.
Buffer - buffer containing the data to be written.
Index - the byte offset of the data to be written in the Buffer.
Size - the maximum number of bytes to write.
ErrorCode -

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

Call this method to write data to the file.