Chilkat.Rar PHP Reference

Chilkat.Rar

Object Creation

$obj = new COM("Chilkat.Rar");

Properties

string LastErrorHtml (read-only)

Error information in HTML format for the last method called.

string LastErrorText (read-only)

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

string LastErrorXml (read-only)

Error information in XML format for the last method called.

int NumEntries (read-only)

The number of files and directories in the RAR archive.

Methods

bool Close()

Closes a RAR archive.

Returns 1 for success, 0 for failure.

bool FastOpen(string filename)

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.

Chilkat.RarEntry GetEntryByIndex(int index)

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.

Chilkat.RarEntry GetEntryByName(string filename)

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.

bool Open(string filename)

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.

bool SaveLastError(string filename)

Saves the last error information to an XML formatted file.

bool Unrar(string dirPath)

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.