ChilkatBz2 ActiveX Reference
ChilkatBz2
Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.
Object Creation
(Visual Basic 6.0)
Dim obj As New ChilkatBz2
(ASP)
set obj = Server.CreateObject("Chilkat.Bz2")
(VBScript)
set obj = CreateObject("Chilkat.Bz2")
(Delphi)
obj := TChilkatBz2.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.Bz2')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Bz2', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.Bz2");
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.
Methods
CompressFile(inFilename As String, outBz2Filename As String) As Long
Compresses a file to create a BZip2 compressed file (.bz2). Returns 1 for success, 0 for failure.
CompressFileToMem(inFilename As String) As Variant
BZip2 compresses a file to an in-memory image of a .bz2 file. Returns an empty Variant on failure. Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.
CompressMemToFile(inData As Variant, outFilename As String) As Long
BZip2 compresses and creates a .bz2 file from in-memory data. Returns 1 for success, 0 for failure.
CompressMemory(inData As Variant) As Variant
Compresses in-memory data to an in-memory image of a .bz2 file. Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.
SaveLastError(logFilename As String) As Long
Saves the last error information to an XML formatted file.
UncompressFile(inFilename As String, outFilename As String) As Long
Unzips a .bz2 file. Returns 1 for success, 0 for failure.
UncompressFileToMem(inFilename As String) As Variant
Unzips a .bz2 file directly to memory. Returns an empty Variant on failure. Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.
UncompressMemToFile(inData As Variant, outFilename As String) As Long
Unzips from an in-memory image of a .bz2 file to a file. Returns 1 for success, 0 for failure.
UncompressMemory(inData As Variant) As Variant
Unzips from an in-memory image of a .bz2 file directly into memory. Returns an empty Variant on failure. Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.
UnlockComponent(regCode As String) As Long
Unlocks the component allowing for the full functionality to be used. If a permanent (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 1 for success, 0 for failure. Diagnosing UnlockComponent Problems UnlockComponent LastErrorText shows exact string passed to it. Verify UnlockComponent Success w/ Permanent Unlock Code LastErrorText Standard Information How UnlockComponent Works
|