Gzip Delphi DLL Reference Documentation

Gzip

Current Version: 9.5.0.73

GZip compression component.

Create/Dispose

var
myObject: HCkGzip;

begin
myObject := CkGzip_Create();

// ...

CkGzip_Dispose(myObject);
end;
function CkGzip_Create: HCkGzip; stdcall;

Creates an instance of the HCkGzip object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkGzip_Dispose(handle: HCkGzip); stdcall;

Objects created by calling CkGzip_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AbortCurrent
function CkGzip_getAbortCurrent(objHandle: HCkGzip): wordbool; stdcall;
procedure CkGzip_putAbortCurrent(objHandle: HCkGzip; newPropVal: wordbool); stdcall;
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
Comment
procedure CkGzip_getComment(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
procedure CkGzip_putComment(objHandle: HCkGzip; newPropVal: PWideChar); stdcall;
function CkGzip__comment(objHandle: HCkGzip): PWideChar; stdcall;

Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called.

top
CompressionLevel
function CkGzip_getCompressionLevel(objHandle: HCkGzip): Integer; stdcall;
procedure CkGzip_putCompressionLevel(objHandle: HCkGzip; newPropVal: Integer); stdcall;
Introduced in version 9.5.0.50

The compression level to be used when compressing. The default is 6, which is the typical value used for zip utility programs when compressing data. The compression level may range from 0 (no compression) to 9 (the most compression). The benefits of trying to increase compression may not be worth the added expense in compression time. In many cases (which is data dependent), the improvement in compression is minimal while the increase in computation time is significant.

top
DebugLogFilePath
procedure CkGzip_getDebugLogFilePath(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
procedure CkGzip_putDebugLogFilePath(objHandle: HCkGzip; newPropVal: PWideChar); stdcall;
function CkGzip__debugLogFilePath(objHandle: HCkGzip): PWideChar; stdcall;

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
ExtraData
procedure CkGzip_getExtraData(objHandle: HCkGzip; outPropVal: HCkByteData); stdcall;
procedure CkGzip_putExtraData(objHandle: HCkGzip; newPropVal: HCkByteData); stdcall;

Optional extra-data that can be included within a .gz when a Compress* method is called.

top
Filename
procedure CkGzip_getFilename(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
procedure CkGzip_putFilename(objHandle: HCkGzip; newPropVal: PWideChar); stdcall;
function CkGzip__filename(objHandle: HCkGzip): PWideChar; stdcall;

The filename that is embedded within the .gz during any Compress* method call. When extracting from a .gz using applications such as WinZip, this will be the filename that is created.

top
LastErrorHtml
procedure CkGzip_getLastErrorHtml(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
function CkGzip__lastErrorHtml(objHandle: HCkGzip): PWideChar; stdcall;

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
procedure CkGzip_getLastErrorText(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
function CkGzip__lastErrorText(objHandle: HCkGzip): PWideChar; stdcall;

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
procedure CkGzip_getLastErrorXml(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
function CkGzip__lastErrorXml(objHandle: HCkGzip): PWideChar; stdcall;

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
function CkGzip_getLastMethodSuccess(objHandle: HCkGzip): wordbool; stdcall;
procedure CkGzip_putLastMethodSuccess(objHandle: HCkGzip; newPropVal: wordbool); stdcall;
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
LastModStr
procedure CkGzip_getLastModStr(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
procedure CkGzip_putLastModStr(objHandle: HCkGzip; newPropVal: PWideChar); stdcall;
function CkGzip__lastModStr(objHandle: HCkGzip): PWideChar; stdcall;

The same as the LastMod property, but allows the date/time to be get/set in RFC822 string format.

top
UseCurrentDate
function CkGzip_getUseCurrentDate(objHandle: HCkGzip): wordbool; stdcall;
procedure CkGzip_putUseCurrentDate(objHandle: HCkGzip; newPropVal: wordbool); stdcall;

If set to True, the file produced by an Uncompress* method will use the current date/time for the last-modification date instead of the date/time found within the Gzip format.

top
VerboseLogging
function CkGzip_getVerboseLogging(objHandle: HCkGzip): wordbool; stdcall;
procedure CkGzip_putVerboseLogging(objHandle: HCkGzip; newPropVal: wordbool); stdcall;

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
procedure CkGzip_getVersion(objHandle: HCkGzip; outPropVal: HCkString); stdcall;
function CkGzip__version(objHandle: HCkGzip): PWideChar; stdcall;

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

top

Methods

CompressBd
function CkGzip_CompressBd(objHandle: HCkGzip;
    binDat: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.67

In-place gzip the contents of binDat.

Returns True for success, False for failure.

More Information and Examples
top
CompressBdAsync (1)
function CkGzip_CompressBdAsync(objHandle: HCkGzip;
    binDat: HCkBinData): HCkTask; stdcall;
Introduced in version 9.5.0.67

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

Returns nil on failure

top
CompressFile
function CkGzip_CompressFile(objHandle: HCkGzip;
    inFilename: PWideChar;
    destPath: PWideChar): wordbool; stdcall;

Compresses a file to create a GZip compressed file (.gz).

Returns True for success, False for failure.

top
CompressFileAsync (1)
function CkGzip_CompressFileAsync(objHandle: HCkGzip;
    inFilename: PWideChar;
    destPath: PWideChar): HCkTask; stdcall;

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 nil on failure

top
CompressFile2
function CkGzip_CompressFile2(objHandle: HCkGzip;
    inFilename: PWideChar;
    embeddedFilename: PWideChar;
    destPath: PWideChar): wordbool; stdcall;

Compresses a file to create a GZip compressed file (.gz). inFilename is the actual filename on disk. embeddedFilename is the filename to be embedded in the .gz such that when it is un-gzipped, this is the name of the file that will be created.

Returns True for success, False for failure.

top
CompressFile2Async (1)
function CkGzip_CompressFile2Async(objHandle: HCkGzip;
    inFilename: PWideChar;
    embeddedFilename: PWideChar;
    destPath: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
CompressFileToMem
function CkGzip_CompressFileToMem(objHandle: HCkGzip;
    inFilename: PWideChar;
    outData: HCkByteData): wordbool; stdcall;

Gzip compresses a file to an in-memory image of a .gz file.

Returns True for success, False for failure.

top
CompressFileToMemAsync (1)
function CkGzip_CompressFileToMemAsync(objHandle: HCkGzip;
    inFilename: PWideChar): HCkTask; stdcall;

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 nil on failure

top
CompressMemory
function CkGzip_CompressMemory(objHandle: HCkGzip;
    inData: HCkByteData;
    outData: HCkByteData): wordbool; stdcall;

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

Returns True for success, False for failure.

top
CompressMemoryAsync (1)
function CkGzip_CompressMemoryAsync(objHandle: HCkGzip;
    inData: HCkByteData): HCkTask; stdcall;

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 nil on failure

top
CompressMemToFile
function CkGzip_CompressMemToFile(objHandle: HCkGzip;
    inData: HCkByteData;
    destPath: PWideChar): wordbool; stdcall;

Gzip compresses and creates a .gz file from in-memory data.

Returns True for success, False for failure.

top
CompressMemToFileAsync (1)
function CkGzip_CompressMemToFileAsync(objHandle: HCkGzip;
    inData: HCkByteData;
    destPath: PWideChar): HCkTask; stdcall;

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 nil on failure

top
CompressString
function CkGzip_CompressString(objHandle: HCkGzip;
    inStr: PWideChar;
    destCharset: PWideChar;
    outBytes: HCkByteData): wordbool; stdcall;

Gzip compresses a string and writes the output to a byte array. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns True for success, False for failure.

More Information and Examples
top
CompressStringAsync (1)
function CkGzip_CompressStringAsync(objHandle: HCkGzip;
    inStr: PWideChar;
    destCharset: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
CompressStringENC
function CkGzip_CompressStringENC(objHandle: HCkGzip;
    inStr: PWideChar;
    charset: PWideChar;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__compressStringENC(objHandle: HCkGzip;
    inStr: PWideChar;
    charset: PWideChar;
    encoding: PWideChar): PWideChar; stdcall;

The same as CompressString, except the binary output is returned in encoded string form according to the encoding. The encoding can be any of the following: "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns True for success, False for failure.

top
CompressStringToFile
function CkGzip_CompressStringToFile(objHandle: HCkGzip;
    inStr: PWideChar;
    destCharset: PWideChar;
    destPath: PWideChar): wordbool; stdcall;

Gzip compresses a string and writes the output to a .gz compressed file. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns True for success, False for failure.

More Information and Examples
top
CompressStringToFileAsync (1)
function CkGzip_CompressStringToFileAsync(objHandle: HCkGzip;
    inStr: PWideChar;
    destCharset: PWideChar;
    destPath: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
Decode
function CkGzip_Decode(objHandle: HCkGzip;
    encodedStr: PWideChar;
    encoding: PWideChar;
    outBytes: HCkByteData): wordbool; stdcall;

Decodes an encoded string and returns the original data. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns True for success, False for failure.

top
DeflateStringENC
function CkGzip_DeflateStringENC(objHandle: HCkGzip;
    inString: PWideChar;
    charsetName: PWideChar;
    outputEncoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__deflateStringENC(objHandle: HCkGzip;
    inString: PWideChar;
    charsetName: PWideChar;
    outputEncoding: PWideChar): PWideChar; stdcall;

Provides the ability to use the zip/gzip's deflate algorithm directly to compress a string. Internal to this method, inString is first converted to the charset specified by charsetName. The data is then compressed using the deflate compression algorithm. The binary output is then encoded according to outputEncoding. Possible values for outputEncoding are "hex", "base64", "url", and "quoted-printable".

Note: The output of this method is compressed data with no Gzip file format. Use the Compress* methods to produce Gzip file format output.

Returns True for success, False for failure.

More Information and Examples
top
Encode
function CkGzip_Encode(objHandle: HCkGzip;
    byteData: HCkByteData;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__encode(objHandle: HCkGzip;
    byteData: HCkByteData;
    encoding: PWideChar): PWideChar; stdcall;

Encodes binary data to a printable string. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns True for success, False for failure.

top
ExamineFile
function CkGzip_ExamineFile(objHandle: HCkGzip;
    inGzFilename: PWideChar): wordbool; stdcall;

Determines if the inGzFilename is a Gzip formatted file. Returns True if it is a Gzip formatted file, otherwise returns False.

top
ExamineMemory
function CkGzip_ExamineMemory(objHandle: HCkGzip;
    inGzData: HCkByteData): wordbool; stdcall;

Determines if the in-memory bytes (inGzData) contain a Gzip formatted file. Returns True if it is Gzip format, otherwise returns False.

top
GetDt
function CkGzip_GetDt(objHandle: HCkGzip): HCkDateTime; stdcall;

Gets the last-modification date/time to be embedded within the .gz.

Returns nil on failure

top
InflateStringENC
function CkGzip_InflateStringENC(objHandle: HCkGzip;
    inString: PWideChar;
    convertFromCharset: PWideChar;
    inputEncoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__inflateStringENC(objHandle: HCkGzip;
    inString: PWideChar;
    convertFromCharset: PWideChar;
    inputEncoding: PWideChar): PWideChar; stdcall;

This the reverse of DeflateStringENC.

The input string is first decoded according to inputEncoding. (Possible values for inputEncoding are "hex", "base64", "url", and "quoted-printable".) The compressed data is then inflated, and the result is then converted from convertFromCharset (if necessary) to return a string.

Returns True for success, False for failure.

top
IsUnlocked
function CkGzip_IsUnlocked(objHandle: HCkGzip): wordbool; stdcall;

Returns True if the component has been unlocked.

top
ReadFile
function CkGzip_ReadFile(objHandle: HCkGzip;
    path: PWideChar;
    outBytes: HCkByteData): wordbool; stdcall;

Reads a binary file into memory and returns the byte array. Note: This method does not parse a Gzip, it is only a convenience method for reading a binary file into memory.

Returns True for success, False for failure.

top
SaveLastError
function CkGzip_SaveLastError(objHandle: HCkGzip;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
SetDt
function CkGzip_SetDt(objHandle: HCkGzip;
    dt: HCkDateTime): wordbool; stdcall;

Sets the last-modification date/time to be embedded within the .gz when a Compress* method is called. If not explicitly set, the current system date/time is used.

Returns True for success, False for failure.

top
UncompressBd
function CkGzip_UncompressBd(objHandle: HCkGzip;
    binDat: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.67

In-place ungzip the contents of binDat.

Returns True for success, False for failure.

top
UncompressBdAsync (1)
function CkGzip_UncompressBdAsync(objHandle: HCkGzip;
    binDat: HCkBinData): HCkTask; stdcall;
Introduced in version 9.5.0.67

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

Returns nil on failure

top
UncompressFile
function CkGzip_UncompressFile(objHandle: HCkGzip;
    srcPath: PWideChar;
    destPath: PWideChar): wordbool; stdcall;

Un-Gzips a .gz file. The output filename is specified by the 2nd argument and not by the filename embedded within the .gz.

Returns True for success, False for failure.

More Information and Examples
top
UncompressFileAsync (1)
function CkGzip_UncompressFileAsync(objHandle: HCkGzip;
    srcPath: PWideChar;
    destPath: PWideChar): HCkTask; stdcall;

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 nil on failure

top
UncompressFileToMem
function CkGzip_UncompressFileToMem(objHandle: HCkGzip;
    inFilename: PWideChar;
    outData: HCkByteData): wordbool; stdcall;

Un-Gzips a .gz file directly to memory.

Returns True for success, False for failure.

top
UncompressFileToMemAsync (1)
function CkGzip_UncompressFileToMemAsync(objHandle: HCkGzip;
    inFilename: PWideChar): HCkTask; stdcall;

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 nil on failure

top
UncompressFileToString
function CkGzip_UncompressFileToString(objHandle: HCkGzip;
    gzFilename: PWideChar;
    charset: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__uncompressFileToString(objHandle: HCkGzip;
    gzFilename: PWideChar;
    charset: PWideChar): PWideChar; stdcall;

Uncompresses a .gz file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc.

Returns True for success, False for failure.

More Information and Examples
top
UncompressFileToStringAsync (1)
function CkGzip_UncompressFileToStringAsync(objHandle: HCkGzip;
    gzFilename: PWideChar;
    charset: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
UncompressMemory
function CkGzip_UncompressMemory(objHandle: HCkGzip;
    inData: HCkByteData;
    outData: HCkByteData): wordbool; stdcall;

Un-Gzips from an in-memory image of a .gz file directly into memory.

Returns True for success, False for failure.

top
UncompressMemoryAsync (1)
function CkGzip_UncompressMemoryAsync(objHandle: HCkGzip;
    inData: HCkByteData): HCkTask; stdcall;

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 nil on failure

top
UncompressMemToFile
function CkGzip_UncompressMemToFile(objHandle: HCkGzip;
    inData: HCkByteData;
    destPath: PWideChar): wordbool; stdcall;

Un-Gzips from an in-memory image of a .gz file to a file.

Returns True for success, False for failure.

top
UncompressMemToFileAsync (1)
function CkGzip_UncompressMemToFileAsync(objHandle: HCkGzip;
    inData: HCkByteData;
    destPath: PWideChar): HCkTask; stdcall;

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 nil on failure

top
UncompressString
function CkGzip_UncompressString(objHandle: HCkGzip;
    inData: HCkByteData;
    inCharset: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__uncompressString(objHandle: HCkGzip;
    inData: HCkByteData;
    inCharset: PWideChar): PWideChar; stdcall;

The reverse of CompressString.

The bytes in inData are uncompressed, then converted from inCharset (if necessary) to return a string.

Returns True for success, False for failure.

More Information and Examples
top
UncompressStringAsync (1)
function CkGzip_UncompressStringAsync(objHandle: HCkGzip;
    inData: HCkByteData;
    inCharset: PWideChar): HCkTask; stdcall;

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

Returns nil on failure

top
UncompressStringENC
function CkGzip_UncompressStringENC(objHandle: HCkGzip;
    inStr: PWideChar;
    charset: PWideChar;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__uncompressStringENC(objHandle: HCkGzip;
    inStr: PWideChar;
    charset: PWideChar;
    encoding: PWideChar): PWideChar; stdcall;

The same as UncompressString, except the compressed data is provided in encoded string form based on the value of encoding. The encoding can be "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns True for success, False for failure.

top
UnlockComponent
function CkGzip_UnlockComponent(objHandle: HCkGzip;
    unlockCode: PWideChar): wordbool; stdcall;

Unlocks the component allowing for the full functionality to be used.

Returns True for success, False for failure.

top
UnTarGz
function CkGzip_UnTarGz(objHandle: HCkGzip;
    tgzFilename: PWideChar;
    destDir: PWideChar;
    bNoAbsolute: wordbool): wordbool; stdcall;

Unpacks a .tar.gz file. The ungzip and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring. bNoAbsolute may be True or False. A value of True protects from untarring to absolute paths. (For example, imagine the trouble if the tar contains files with absolute paths beginning with /Windows/system32)

Returns True for success, False for failure.

top
UnTarGzAsync (1)
function CkGzip_UnTarGzAsync(objHandle: HCkGzip;
    tgzFilename: PWideChar;
    destDir: PWideChar;
    bNoAbsolute: wordbool): HCkTask; stdcall;

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

Returns nil on failure

top
WriteFile
function CkGzip_WriteFile(objHandle: HCkGzip;
    path: PWideChar;
    binaryData: HCkByteData): wordbool; stdcall;

A convenience method for writing a binary byte array to a file.

Returns True for success, False for failure.

top
XfdlToXml
function CkGzip_XfdlToXml(objHandle: HCkGzip;
    xfldData: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkGzip__xfdlToXml(objHandle: HCkGzip;
    xfldData: PWideChar): PWideChar; stdcall;

Converts base64-gzip .xfdl data to a decompressed XML string. The xfldData contains the base64 data. This method returns the decoded/decompressed XML string.

Returns True for success, False for failure.

top