TElZipWriter.Add method

Discuss this help topic in SecureBlackbox Forum

TElZipWriter.Add

TElZipWriter See also

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

Adds entry to the archive.

Declaration

[C#]
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry Parent, string Path);
    TElZipArchiveDirectoryEntry Add(string Path);
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry Parent, string Path, ref TSBZipAddEntryResult AddResult);
    TElZipArchiveDirectoryEntry Add(string Path, ref TSBZipAddEntryResult AddResult);
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry Parent, System.IO.Stream Stream);
    TElZipArchiveDirectoryEntry Add(System.IO.Stream Stream);
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry Parent, System.IO.Stream Stream, string FileName);
    TElZipArchiveDirectoryEntry Add(System.IO.Stream Stream, string FileName);
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry Parent, byte[] Buf, int StartIndex, int Count, string FileName);
    TElZipArchiveDirectoryEntry Add(byte[] Buf, int StartIndex, int Count, string FileName);

[VB.NET]
    Function Add(ByVal Parent As TElZipArchiveDirectoryEntry, ByVal Path As String) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Path As String) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Parent As TElZipArchiveDirectoryEntry, ByVal Path As String, ByRef AddResult As TSBZipAddEntryResult) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Path As String, , ByRef AddResult As TSBZipAddEntryResult) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Parent As TElZipArchiveDirectoryEntry, ByVal Stream As System.IO.Stream) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Stream As System.IO.Stream) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Parent As TElZipArchiveDirectoryEntry, ByVal Stream As System.IO.Stream, ByVal FileName As String) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Stream As System.IO.Stream, ByVal FileName As String) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Parent As TElZipArchiveDirectoryEntry, ByVal Buf As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal FileName As String) As TElZipArchiveDirectoryEntry
    Function Add(ByVal Buf As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal FileName As String) As TElZipArchiveDirectoryEntry

[Pascal]
    function Add(Parent : TElZipArchiveDirectoryEntry; const Path : string): TElZipArchiveDirectoryEntry;
    function Add(const Path : string): TElZipArchiveDirectoryEntry;
    function Add(Parent : TElZipArchiveDirectoryEntry; const Path : string; out AddResult : TSBZipAddEntryResult): TElZipArchiveDirectoryEntry;
    function Add(const Path : string; out AddResult : TSBZipAddEntryResult): TElZipArchiveDirectoryEntry;
    function Add(Parent : TElZipArchiveDirectoryEntry; Stream : TStream): TElZipArchiveDirectoryEntry;
    function Add(Stream : TStream): TElZipArchiveDirectoryEntry;
    function Add(Parent : TElZipArchiveDirectoryEntry; Stream : TStream; const FileName : string): TElZipArchiveDirectoryEntry;
    function Add(Stream : TStream; const FileName : string): TElZipArchiveDirectoryEntry;

[C++]
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry &Parent, const std::string &Path);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry *Parent, const std::string &Path);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry &Parent, const std::string &Path, TSBZipAddEntryResult &AddResult);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry *Parent, const std::string &Path, TSBZipAddEntryResult &AddResult);
    TElZipArchiveDirectoryEntryHandle Add(const std::string &Path, TSBZipAddEntryResult &AddResult);
    TElZipArchiveDirectoryEntryHandle Add(const std::string &Path);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry &Parent, TStream &Stream);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry *Parent, TStream *Stream);
    TElZipArchiveDirectoryEntryHandle Add(TStream &Stream);
    TElZipArchiveDirectoryEntryHandle Add(TStream *Stream);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry &Parent, TStream &Stream, const std::string &FileName);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry *Parent, TStream *Stream, const std::string &FileName);
    TElZipArchiveDirectoryEntryHandle Add(TStream &Stream, const std::string &FileName);
    TElZipArchiveDirectoryEntryHandle Add(TStream *Stream, const std::string &FileName);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry &Parent, const std::vector<uint8_t> &Buf, int32_t StartIndex, int32_t Count, const std::string &FileName);
    TElZipArchiveDirectoryEntryHandle Add(TElZipArchiveDirectoryEntry *Parent, const std::vector<uint8_t> &Buf, int32_t StartIndex, int32_t Count, const std::string &FileName);
    TElZipArchiveDirectoryEntryHandle Add(const std::vector<uint8_t> &Buf, int32_t StartIndex, int32_t Count, const std::string &FileName);

[PHP]
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry $Parent, string $Path)
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry $Parent, string $Path, integer &$AddResult)
    TElZipArchiveDirectoryEntry Add(string $Path, integer &$AddResult)
    TElZipArchiveDirectoryEntry Add(string $Path)
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry $Parent, TStream $Stream)
    TElZipArchiveDirectoryEntry Add(TStream $Stream)
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry $Parent, TStream $Stream, string $FileName)
    TElZipArchiveDirectoryEntry Add(TStream $Stream, string $FileName)
    TElZipArchiveDirectoryEntry Add(TElZipArchiveDirectoryEntry $Parent, array of byte|string|NULL $Buf, integer $StartIndex, integer $Count, string $FileName)
    TElZipArchiveDirectoryEntry Add(array of byte|string|NULL $Buf, integer $StartIndex, integer $Count, string $FileName)

[Java]
    TElZipArchiveDirectoryEntry add(String Path);
    TElZipArchiveDirectoryEntry add(String Path, TSBZipAddEntryResult AddResult);
    TElZipArchiveDirectoryEntry add(TElZipArchiveDirectoryEntry Parent, String Path);
    TElZipArchiveDirectoryEntry add(TElZipArchiveDirectoryEntry Parent, String Path, TSBZipAddEntryResult AddResult);
    TElZipArchiveDirectoryEntry add(TElZipArchiveDirectoryEntry Parent, byte[] Buf, int StartIndex, int Count, String FileName);
    TElZipArchiveDirectoryEntry add(TElStream Stream, String FileName);
    TElZipArchiveDirectoryEntry add(byte[] Buf, int StartIndex, int Count, String FileName);
    TElZipArchiveDirectoryEntry add(TElZipArchiveDirectoryEntry Parent, TElStream Stream);
    TElZipArchiveDirectoryEntry add(TElZipArchiveDirectoryEntry Parent, TElStream Stream, String FileName);
    TElZipArchiveDirectoryEntry add(TElStream Stream);

Parameters

Parent - entry directory to which the new entry should be added. If this parameter is omitted, path is relative to the root directory.
Path - path to the entry which should be added to the archive
Stream - input stream with uncompressed data
FileName - name of the new archive directory entry. If this parameter is omitted, the name will be generated automatically.
Buf - input buffer with uncompressed data.
StartIndex - the index of the first byte of the actual uncompressed data in Buf.
Count - the number of bytes to be read from Buf.
AddResult - this parameter allows to check what kind of operation has been performed by the component.

TSBZipAddEntryResult values

[.NET][C++]	[Pascal]	[PHP]	Description
aerAdded = 0	aerAdded	aerAdded = 0	The entry was successfully added to the archive.
aerReplaced = 1	aerReplaced	aerReplaced = 1	The new entry has replaced an existing entry.
aerUpdated = 2	aerUpdated	aerUpdated = 2	The existing entry was updated with the new one.
aerSkipped = 3	aerSkipped	aerSkipped = 3	The entry was not added.

Return value

TElZipArchiveDirectoryEntry object which represents a newly added entry.

Description

Use this method to add a new entry to the archive directory.

See also: CreateArchive

Discuss this help topic in SecureBlackbox Forum