Discuss this help topic in SecureBlackbox Forum

TElTarWriter.Add

TElTarWriter     See also     


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


Adds a new entry to the archive.

Declaration

[VB.NET]
    Function Add(ByVal Parent As TElTarArchiveDirectoryEntry, ByVal Path As String, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry
    Function Add(ByVal Path As String, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry
    Function Add(ByVal Parent As TElTarArchiveDirectoryEntry, ByVal Stream As System.IO.Stream, ByVal FileName As String, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry
    Function Add(ByVal Parent As TElTarArchiveDirectoryEntry, ByVal Stream As System.IO.Stream, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry
    Function Add(ByVal Stream As System.IO.Stream, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry
    Function Add(ByVal Stream As System.IO.Stream, ByVal FileName As String, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry
    Function Add(ByVal Parent As TElTarArchiveDirectoryEntry, ByVal Buf As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal FileName As String, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry
    Function Add(ByVal Buf As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal FileName As String, ByVal Mode As Integer, ByVal USTAR As TElUStarTarHeader) As TElTarArchiveDirectoryEntry

[Pascal]
    function Add(Parent : TElTarArchiveDirectoryEntry; const Path : string; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;
    function Add(const Path : string; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;
    function Add(Parent : TElTarArchiveDirectoryEntry; Stream : TStream; const FileName : string; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;
    function Add(Parent : TElTarArchiveDirectoryEntry; Stream : TStream; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;
    function Add(Stream : TStream; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;
    function Add(Stream : TStream; const FileName : string; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;
    function Add(Parent : TElTarArchiveDirectoryEntry; const Buf : ByteArray; StartIndex : integer; Count : integer; const FileName : string; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;
    function Add(const Buf : ByteArray; StartIndex : integer; Count : integer; const FileName : string; Mode : integer = 0; USTAR : TElUStarTarHeader = nil) : TElTarArchiveDirectoryEntry; overload;

[C++]
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry &Parent, const std::string &Path, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry *Parent, const std::string &Path, int32_t Mode, TElUStarTarHeader *USTAR);
    TElTarArchiveDirectoryEntryHandle Add(const std::string &Path, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(const std::string &Path, int32_t Mode, TElUStarTarHeader *USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry &Parent, TStream &Stream, const std::string &FileName, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry *Parent, TStream *Stream, const std::string &FileName, int32_t Mode, TElUStarTarHeader *USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry &Parent, TStream &Stream, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry *Parent, TStream *Stream, int32_t Mode, TElUStarTarHeader *USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TStream &Stream, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TStream *Stream, int32_t Mode, TElUStarTarHeader *USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TStream &Stream, const std::string &FileName, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TStream *Stream, const std::string &FileName, int32_t Mode, TElUStarTarHeader *USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry &Parent, const std::vector<uint8_t> &Buf, int32_t StartIndex, int32_t Count, const std::string &FileName, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(TElTarArchiveDirectoryEntry *Parent, const std::vector<uint8_t> &Buf, int32_t StartIndex, int32_t Count, const std::string &FileName, int32_t Mode, TElUStarTarHeader *USTAR);
    TElTarArchiveDirectoryEntryHandle Add(const std::vector<uint8_t> &Buf, int32_t StartIndex, int32_t Count, const std::string &FileName, int32_t Mode, TElUStarTarHeader &USTAR);
    TElTarArchiveDirectoryEntryHandle Add(const std::vector<uint8_t> &Buf, int32_t StartIndex, int32_t Count, const std::string &FileName, int32_t Mode, TElUStarTarHeader *USTAR);

[PHP]
    TElTarArchiveDirectoryEntry Add(TElTarArchiveDirectoryEntry $Parent, string $Path, integer $Mode, TElUStarTarHeader $USTAR)
    TElTarArchiveDirectoryEntry Add(string $Path, integer $Mode, TElUStarTarHeader $USTAR)
    TElTarArchiveDirectoryEntry Add(TElTarArchiveDirectoryEntry $Parent, TStream $Stream, string $FileName, integer $Mode, TElUStarTarHeader $USTAR)
    TElTarArchiveDirectoryEntry Add(TElTarArchiveDirectoryEntry $Parent, TStream $Stream, integer $Mode, TElUStarTarHeader $USTAR)
    TElTarArchiveDirectoryEntry Add(TStream $Stream, integer $Mode, TElUStarTarHeader $USTAR)
    TElTarArchiveDirectoryEntry Add(TStream $Stream, string $FileName, integer $Mode, TElUStarTarHeader $USTAR)
    TElTarArchiveDirectoryEntry Add(TElTarArchiveDirectoryEntry $Parent, array of byte|string|NULL $Buf, integer $StartIndex, integer $Count, string $FileName, integer $Mode, TElUStarTarHeader $USTAR)
    TElTarArchiveDirectoryEntry Add(array of byte|string|NULL $Buf, integer $StartIndex, integer $Count, string $FileName, integer $Mode, TElUStarTarHeader $USTAR)

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
  • Mode - the value of the Mode attribute of the new entry.
  • USTAR - USTar attribute values.
  • 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.

Return value

Returns a TElTarArchiveDirectoryEntry object which represents a newly added entry.

Description

Use this method to add an entry to be archived.

See also:     CreateArchive    

Discuss this help topic in SecureBlackbox Forum