ChilkatRar ActiveX Reference

ChilkatRar

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatRar
(ASP)
set obj = Server.CreateObject("Chilkat.Rar")
(VBScript)
set obj = CreateObject("Chilkat.Rar")
(Delphi)
obj := TChilkatRar.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.Rar')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Rar', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.Rar");

Properties

LastErrorHtml As String (read-only)

Error information in HTML format for the last method called.

LastErrorText As String (read-only)

Error information in plain-text format for the last method called.

LastErrorXml As String (read-only)

Error information in XML format for the last method called.

NumEntries As Long (read-only)

The number of files and directories in the RAR archive.

Methods

Close() As Long

Closes a RAR archive.

Returns 1 for success, 0 for failure.

FastOpen(filename As String) As Long

Opens a RAR archive. The filename may include an absolute or relative directory path. This method does not iterate over the entries in the RAR archive. The NumEntries property will remain at 0 after FastOpen is called. FastOpen is provided as a quicker means to open a RAR archive if the intended usage is to simply call Unrar to extract the files and directories.

Returns 1 for success, 0 for failure.

GetEntryByIndex(index As Long) As ChilkatRarEntry

Returns a RarEntry object for the Nth entry in the RAR archive. The archive must have first been opened by calling Open (not FastOpen). Returns null if the index is out of range. The 1st entry is at index 0.

GetEntryByName(filename As String) As ChilkatRarEntry

Returns a RarEntry object by filename. The RAR archive must have first been opened by calling Open (not FastOpen). Returns null if the entry was not found.

Open(filename As String) As Long

Opens a RAR archive. The filename may include an absolute or relative directory path. This method iterates over the files and directories. Upon returning, the NumEntries property contains the number of files/directories in the RAR, and GetEntryByIndex may be called to retrieve information about each file/directory.

Returns 1 for success, 0 for failure.

SaveLastError(filename As String) As Long

Saves the last error information to an XML formatted file.

Unrar(dirPath As String) As Long

Extracts the files and directories from a RAR archive. The directory tree contained within the RAR is re-created with it's root at dirPath.

Returns 1 for success, 0 for failure.