Chilkat_9_5_0.Bz2 PHP ActiveX Reference Documentation

Chilkat_9_5_0.Bz2

Current Version: 9.5.0.75

Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.

Object Creation

$obj = new COM("Chilkat_9_5_0.Bz2");

Properties

AbortCurrent
bool AbortCurrent
Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
DebugLogFilePath
string DebugLogFilePath

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastBinaryResult
VARIANT LastBinaryResult (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
string LastErrorHtml (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
string LastErrorText (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
string LastErrorXml (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
bool LastMethodSuccess
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
string LastStringResult (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
int LastStringResultLen (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
VerboseLogging
bool VerboseLogging

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
string Version (read-only)

Version of the component/library, such as "9.5.0.63"

top

Methods

CompressFile
bool CompressFile(string inFilename, string toPath)

Compresses a file to create a BZip2 compressed file (.bz2).

Returns true for success, false for failure.

top
CompressFileAsync (1)
Chilkat_9_5_0.Task CompressFileAsync(string inFilename, string toPath)

Creates an asynchronous task to call the CompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
CompressFileToMem
VARIANT CompressFileToMem(string inFilename)

BZip2 compresses a file to an in-memory image of a .bz2 file.

Returns null on failure

top
CompressFileToMemAsync (1)
Chilkat_9_5_0.Task CompressFileToMemAsync(string inFilename)

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
CompressMemory
VARIANT CompressMemory(VARIANT inData)

Compresses in-memory data to an in-memory image of a .bz2 file.

Returns null on failure

top
CompressMemoryAsync (1)
Chilkat_9_5_0.Task CompressMemoryAsync(VARIANT inData)

Creates an asynchronous task to call the CompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
CompressMemToFile
bool CompressMemToFile(VARIANT inData, string toPath)

BZip2 compresses and creates a .bz2 file from in-memory data.

Returns true for success, false for failure.

top
CompressMemToFileAsync (1)
Chilkat_9_5_0.Task CompressMemToFileAsync(VARIANT inData, string toPath)

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
UncompressFile
bool UncompressFile(string inFilename, string toPath)

Unzips a .bz2 file.

Returns true for success, false for failure.

top
UncompressFileAsync (1)
Chilkat_9_5_0.Task UncompressFileAsync(string inFilename, string toPath)

Creates an asynchronous task to call the UncompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
UncompressFileToMem
VARIANT UncompressFileToMem(string inFilename)

Unzips a .bz2 file directly to memory.

Returns null on failure

top
UncompressFileToMemAsync (1)
Chilkat_9_5_0.Task UncompressFileToMemAsync(string inFilename)

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
UncompressMemory
VARIANT UncompressMemory(VARIANT inData)

Unzips from an in-memory image of a .bz2 file directly into memory.

Returns null on failure

top
UncompressMemoryAsync (1)
Chilkat_9_5_0.Task UncompressMemoryAsync(VARIANT inData)

Creates an asynchronous task to call the UncompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
UncompressMemToFile
bool UncompressMemToFile(VARIANT inData, string toPath)

Unzips from an in-memory image of a .bz2 file to a file.

Returns true for success, false for failure.

top
UncompressMemToFileAsync (1)
Chilkat_9_5_0.Task UncompressMemToFileAsync(VARIANT inData, string toPath)

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
UnlockComponent
bool UnlockComponent(string regCode)

Unlocks the component allowing for the full functionality to be used. If a purchased unlock code is passed, there is no expiration. Any other string automatically begins a fully-functional 30-day trial the first time UnlockComponent is called.

Returns true for success, false for failure.

top