Tar Unicode C Reference Documentation

Tar

Current Version: 9.5.0.73

API for creating and extracting TAR archives. Also supports creating and extracting .tar.gz (.tgz), .tar.bz2, and .tar.Z (compressed TAR archives, also known as compressed tarball archives). Can read/write the following TAR formats: (1) GNU tar 1.13.x format, (2) PAX -- POSIX 1003.1-2001 format, (3) USTAR -- POSIX 1003.1-1988 format.

Create/Dispose

HCkTarW instance = CkTarW_Create();
// ...
CkTarW_Dispose(instance);
HCkTarW CkTarW_Create(void);

Creates an instance of the HCkTarW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkTarW_Dispose(HCkTarW handle);

Objects created by calling CkTarW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkTarW_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkTarW_setAbortCheck(HCkTarW cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkTarW_setPercentDone(HCkTarW cHandle, BOOL (*fnPercentDone)(int pctDone));

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkTarW_setProgressInfo(HCkTarW cHandle, void (*fnProgressInfo)(const wchar_t *name, const wchar_t *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkTarW_setTaskCompleted(HCkTarW cHandle, void (*fnTaskCompleted)(HCkTaskW hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

CaptureXmlListing
BOOL CkTarW_getCaptureXmlListing(HCkTarW cHandle);
void CkTarW_putCaptureXmlListing(HCkTarW cHandle, BOOL newVal);
Introduced in version 9.5.0.46

If TRUE, then untar methods, such as Untar, UntarGz, UntarBz2, and UntarZ, will also capture an XML listing of the contents in the XmlListing property. The format of the XML contained in XmlListing is identical to what is returned by the ListXml method. The default value is FALSE.

top
Charset
void CkTarW_getCharset(HCkTarW cHandle, HCkString retval);
void CkTarW_putCharset(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_charset(HCkTarW cHandle);

Character encoding to be used when interpreting filenames within .tar archives for untar operations. The default is "utf-8", and this is typically not changed. (The WriteTar methods always uses utf-8 to store filenames within the TAR archive.)

top
DebugLogFilePath
void CkTarW_getDebugLogFilePath(HCkTarW cHandle, HCkString retval);
void CkTarW_putDebugLogFilePath(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_debugLogFilePath(HCkTarW cHandle);

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
DirMode
int CkTarW_getDirMode(HCkTarW cHandle);
void CkTarW_putDirMode(HCkTarW cHandle, int newVal);

The directory permissions to used in WriteTar* methods. The default is octal 0755. This is the value to be stored in the "mode" field of each TAR header for a directory entries.

top
DirPrefix
void CkTarW_getDirPrefix(HCkTarW cHandle, HCkString retval);
void CkTarW_putDirPrefix(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_dirPrefix(HCkTarW cHandle);

A prefix to be added to each file's path within the TAR archive as it is being created. For example, if this property is set to the string "subdir1", then "subdir1/" will be prepended to each file's path within the TAR.

Note: This property does not apply to files added using the AddFile2 method, which directly specifies the path-in-tar.

top
FileMode
int CkTarW_getFileMode(HCkTarW cHandle);
void CkTarW_putFileMode(HCkTarW cHandle, int newVal);

The file permissions to used in WriteTar* methods. The default is octal 0644. This is the value to be stored in the "mode" field of each TAR header for a file entries.

top
GroupId
int CkTarW_getGroupId(HCkTarW cHandle);
void CkTarW_putGroupId(HCkTarW cHandle, int newVal);

The default numerical GID to be stored in each TAR header when writing TAR archives. The default value is 1000.

top
GroupName
void CkTarW_getGroupName(HCkTarW cHandle, HCkString retval);
void CkTarW_putGroupName(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_groupName(HCkTarW cHandle);

The default group name to be stored in each TAR header when writing TAR archives. The default value is the logged-on username of the application's process.

top
HeartbeatMs
int CkTarW_getHeartbeatMs(HCkTarW cHandle);
void CkTarW_putHeartbeatMs(HCkTarW cHandle, int newVal);

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any TAR operation prior to completion. If HeartbeatMs is 0, no AbortCheck event callbacks will occur.

top
LastErrorHtml
void CkTarW_getLastErrorHtml(HCkTarW cHandle, HCkString retval);
const wchar_t *CkTarW_lastErrorHtml(HCkTarW cHandle);

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
void CkTarW_getLastErrorText(HCkTarW cHandle, HCkString retval);
const wchar_t *CkTarW_lastErrorText(HCkTarW cHandle);

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
void CkTarW_getLastErrorXml(HCkTarW cHandle, HCkString retval);
const wchar_t *CkTarW_lastErrorXml(HCkTarW cHandle);

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 CkTarW_getLastMethodSuccess(HCkTarW cHandle);
void CkTarW_putLastMethodSuccess(HCkTarW cHandle, BOOL newVal);
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
MatchCaseSensitive
BOOL CkTarW_getMatchCaseSensitive(HCkTarW cHandle);
void CkTarW_putMatchCaseSensitive(HCkTarW cHandle, BOOL newVal);
Introduced in version 9.5.0.46

Determines whether pattern matching for the MustMatch and MustNotMatch properties is case-sensitive or not. The default value is FALSE.

top
MustMatch
void CkTarW_getMustMatch(HCkTarW cHandle, HCkString retval);
void CkTarW_putMustMatch(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_mustMatch(HCkTarW cHandle);
Introduced in version 9.5.0.46

If set, then file paths must match this pattern when creating TAR archives, or when extracting from TAR archives. If a file does not match, it will not be included when creating a TAR, or it will not be extracted when extracting from a TAR. This property also applies to methods that create or extract from compressed TAR archives.

The must-match pattern may include 0 or more asterisk characters, each of which represents 0 or more of any character. For example, the pattern "*.txt" causes only .txt files to be included or extracted. The default value is an empty string, indicating that all files are implicitly matched.

top
MustNotMatch
void CkTarW_getMustNotMatch(HCkTarW cHandle, HCkString retval);
void CkTarW_putMustNotMatch(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_mustNotMatch(HCkTarW cHandle);
Introduced in version 9.5.0.46

If set, then file paths must NOT match this pattern when creating TAR archives, or when extracting from TAR archives. If a file path matches, it will not be included when creating a TAR, or it will not be extracted when extracting from a TAR. This property also applies to methods that create or extract from compressed TAR archives.

The must-not-match pattern may include 0 or more asterisk characters, each of which represents 0 or more of any character. For example, the pattern "*.obj" causes all .obj files to be skipped. The default value is an empty string, indicating that no files are skipped.

top
NoAbsolutePaths
BOOL CkTarW_getNoAbsolutePaths(HCkTarW cHandle);
void CkTarW_putNoAbsolutePaths(HCkTarW cHandle, BOOL newVal);

If TRUE, then absolute paths are converted to relative paths by removing the leading "/" or "\" character when untarring. This protects your system from unknowingly untarring files into important system directories, such as C:\Windows\system32. The default value is TRUE.

top
NumDirRoots
int CkTarW_getNumDirRoots(HCkTarW cHandle);

The total number of directory roots set by calling AddDirRoot (i.e. the number of times AddDirRoot was called by the application). A TAR archive is created by calling AddDirRoot for one or more directory tree roots, followed by a single call to WriteTar (or WriteTarBz2, WriteTarGz, WriteTarZ). This allows for TAR archives containing multiple directory trees to be created.

top
PercentDoneScale
int CkTarW_getPercentDoneScale(HCkTarW cHandle);
void CkTarW_putPercentDoneScale(HCkTarW cHandle, int newVal);
Introduced in version 9.5.0.49

This property is only valid in programming environment and languages that allow for event callbacks.

Sets the value to be defined as 100% complete for the purpose of PercentDone event callbacks. The defaut value of 100 means that at most 100 event PercentDone callbacks will occur in a method that (1) is event enabled and (2) is such that it is possible to measure progress as a percentage completed. This property may be set to larger numbers to get more fine-grained PercentDone callbacks. For example, setting this property equal to 1000 will provide callbacks with .1 percent granularity. For example, a value of 453 would indicate 45.3% competed. This property is clamped to a minimum value of 10, and a maximum value of 100000.

top
ScriptFileMode
int CkTarW_getScriptFileMode(HCkTarW cHandle);
void CkTarW_putScriptFileMode(HCkTarW cHandle, int newVal);

The file permissions to used in WriteTar* methods for shell script files (.sh, .csh, .bash, .bsh). The default is octal 0755. This is the value to be stored in the "mode" field of each TAR header for a file entries.

top
SuppressOutput
BOOL CkTarW_getSuppressOutput(HCkTarW cHandle);
void CkTarW_putSuppressOutput(HCkTarW cHandle, BOOL newVal);
Introduced in version 9.5.0.46

If TRUE, then untar methods, such as Untar, UntarGz, UntarBz2, and UntarZ, do not produce any output. Setting this value equal to TRUE is useful when the CaptureXmlListing is also set to TRUE, which enables an application to get the contents of a TAR archive without extracting. The default value is FALSE.

top
UntarCaseSensitive
BOOL CkTarW_getUntarCaseSensitive(HCkTarW cHandle);
void CkTarW_putUntarCaseSensitive(HCkTarW cHandle, BOOL newVal);

This property is deprecated. Applications should instead use the MatchCaseSensitive property. Until this property is officially removed, it will behave the same as the MatchCaseSensitive property.

top
UntarDebugLog
BOOL CkTarW_getUntarDebugLog(HCkTarW cHandle);
void CkTarW_putUntarDebugLog(HCkTarW cHandle, BOOL newVal);

Similar to the VerboseLogging property. If set to TRUE, then information about each file/directory extracted in an untar method call is logged to LastErrorText (or LastErrorXml / LastErrorHtml). The default value is FALSE.

top
UntarDiscardPaths
BOOL CkTarW_getUntarDiscardPaths(HCkTarW cHandle);
void CkTarW_putUntarDiscardPaths(HCkTarW cHandle, BOOL newVal);

If TRUE, then discard all path information when untarring. This causes all files to be untarred into a single directory. The default value is FALSE.

top
UntarFromDir
void CkTarW_getUntarFromDir(HCkTarW cHandle, HCkString retval);
void CkTarW_putUntarFromDir(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_untarFromDir(HCkTarW cHandle);

The directory path where files are extracted when untarring. The default value is ".", meaning that the current working directory of the calling process is used. If UntarDiscardPaths is set, then all files are untarred into this directory. Otherwise, the untar operation will re-create a directory tree rooted in this directory.

top
UntarMatchPattern
void CkTarW_getUntarMatchPattern(HCkTarW cHandle, HCkString retval);
void CkTarW_putUntarMatchPattern(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_untarMatchPattern(HCkTarW cHandle);
This property is deprecated. It will be removed in a future version.

This property is deprecated. The MustMatch property should be used instead. Until this property is officially removed from the API, it is identical in behavior the MustMatch property.

top
UntarMaxCount
int CkTarW_getUntarMaxCount(HCkTarW cHandle);
void CkTarW_putUntarMaxCount(HCkTarW cHandle, int newVal);

Limits the number of files extracted during an untar to this count. The default value is 0 to indicate no maximum. To untar a single file, one might set the UntarMatchPattern such that it will match only the file to be extracted, and also set UntarMaxCount equal to 1. This causes an untar to scan the TAR archive until it finds the matching file, extract it, and then return.

top
UserId
int CkTarW_getUserId(HCkTarW cHandle);
void CkTarW_putUserId(HCkTarW cHandle, int newVal);

The default numerical UID to be stored in each TAR header when writing TAR archives. The default value is 1000.

top
UserName
void CkTarW_getUserName(HCkTarW cHandle, HCkString retval);
void CkTarW_putUserName(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_userName(HCkTarW cHandle);

The default user name to be stored in each TAR header when writing TAR archives. The default value is the logged-on username of the application's process.

top
VerboseLogging
BOOL CkTarW_getVerboseLogging(HCkTarW cHandle);
void CkTarW_putVerboseLogging(HCkTarW cHandle, BOOL newVal);

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
void CkTarW_getVersion(HCkTarW cHandle, HCkString retval);
const wchar_t *CkTarW_version(HCkTarW cHandle);

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

top
WriteFormat
void CkTarW_getWriteFormat(HCkTarW cHandle, HCkString retval);
void CkTarW_putWriteFormat(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_writeFormat(HCkTarW cHandle);

The TAR format to use when writing a TAR archive. Valid values are "gnu", "pax", and "ustar". The default value is "gnu".

top
XmlListing
void CkTarW_getXmlListing(HCkTarW cHandle, HCkString retval);
void CkTarW_putXmlListing(HCkTarW cHandle, const wchar_t *newVal);
const wchar_t *CkTarW_xmlListing(HCkTarW cHandle);
Introduced in version 9.5.0.46

Contains the XML listing of the contents of the TAR archive for the last untar method call (such as Untar, UntarGz, etc.) where the CaptureXmlListing property was set to TRUE.

top

Methods

AddDirRoot
BOOL CkTarW_AddDirRoot(HCkTarW cHandle, const wchar_t *dirPath);

Adds a directory tree to be included in the next call to one of the WriteTar* methods. To include multiple directory trees in a .tar, call AddDirRoot multiple times followed by a single call to WriteTar.

Returns TRUE for success, FALSE for failure.

top
AddDirRoot2
BOOL CkTarW_AddDirRoot2(HCkTarW cHandle, const wchar_t *rootPrefix, const wchar_t *rootPath);
Introduced in version 9.5.0.56

Adds a directory tree to be included in the next call to one of the WriteTar* methods. To include multiple directory trees in a .tar, call AddDirRoot2 (and/or AddDirRoot) multiple times followed by a single call to WriteTar.

The rootPrefix adds a prefix to the path in the TAR for all files added under this root. The rootPrefix should not end with a forward-slash char. For example: This is good: "abc/123", but this is not good: "abc/123/". If the DirPrefix property is also set, its prefix will added first.

Returns TRUE for success, FALSE for failure.

top
AddFile
BOOL CkTarW_AddFile(HCkTarW cHandle, const wchar_t *path);
Introduced in version 9.5.0.46

Adds a local file to be included in the next call to one of the WriteTar* methods. To include multiple files or directory trees in a .tar, call AddFile/AddDirRoot multiple times followed by a single call to WriteTar (or WriteTarGz, or WriteTarBz2).

Returns TRUE for success, FALSE for failure.

top
AddFile2
BOOL CkTarW_AddFile2(HCkTarW cHandle, const wchar_t *filePath, const wchar_t *pathWithinTar);
Introduced in version 9.5.0.69

Adds a local file to be included in the next call to one of the WriteTar* methods. Allows for the path within the TAR to be specified. To include multiple files or directory trees in a .tar, call AddFile/AddFile2/AddDirRoot multiple times followed by a single call to WriteTar (or WriteTarGz, or WriteTarBz2).

Note: The DirPrefix property does not apply to files added via this method because this method explicilty specifies the path-in-tar.

Returns TRUE for success, FALSE for failure.

top
CreateDeb
BOOL CkTarW_CreateDeb(HCkTarW cHandle, const wchar_t *controlPath, const wchar_t *dataPath, const wchar_t *debPath);
Introduced in version 9.5.0.66

Creates a .deb Debian binary package archive from a control.tar.gz and data.tar.gz. The controlPath is the path to the control.tar.gz file (or equivalent), and the dataPath is the path to the data.tar.gz file. The output file path (.deb) is specified in debPath.

Returns TRUE for success, FALSE for failure.

top
GetDirRoot
BOOL CkTarW_GetDirRoot(HCkTarW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkTarW_getDirRoot(HCkTarW cHandle, int index);

Returns the value of the Nth directory root. For example, if an application calls AddDirRoot twice, then the NumDirRoots property would have a value of 2, and GetDirRoot(0) would return the path passed to AddDirRoot in the 1st call, and GetDirRoot(1) would return the directory path in the 2nd call to AddDirRoot.

Returns TRUE for success, FALSE for failure.

top
ListXml
BOOL CkTarW_ListXml(HCkTarW cHandle, const wchar_t *tarPath, const wchar_t *outStr);
const wchar_t *CkTarW_listXml(HCkTarW cHandle, const wchar_t *tarPath);

Scans a TAR archive and returns XML detailing the files and directories found within the TAR.

Returns TRUE for success, FALSE for failure.

top
ListXmlAsync (1)
HCkTaskW CkTarW_ListXmlAsync(HCkTarW cHandle, const wchar_t *tarPath);

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

Returns NULL on failure

top
SaveLastError
BOOL CkTarW_SaveLastError(HCkTarW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

top
UnlockComponent
BOOL CkTarW_UnlockComponent(HCkTarW cHandle, const wchar_t *unlockCode);

Unlocks the component allowing for the full functionality to be used. If this method unexpectedly returns FALSE, examine the contents of the LastErrorText property to determine the reason for failure.

top
Untar
int CkTarW_Untar(HCkTarW cHandle, const wchar_t *tarPath);

Extracts the files and directories from a TAR archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property. Returns the number of files and directories extracted, or -1 for failure.

More Information and Examples
top
UntarAsync (1)
HCkTaskW CkTarW_UntarAsync(HCkTarW cHandle, const wchar_t *tarPath);

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

Returns NULL on failure

top
UntarBz2
BOOL CkTarW_UntarBz2(HCkTarW cHandle, const wchar_t *tarPath);

Extracts the files and directories from a tar.bz2 (or tar.bzip2) archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
UntarBz2Async (1)
HCkTaskW CkTarW_UntarBz2Async(HCkTarW cHandle, const wchar_t *tarPath);

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

Returns NULL on failure

top
UntarFirstMatchingToMemory
BOOL CkTarW_UntarFirstMatchingToMemory(HCkTarW cHandle, const unsigned char * tarFileBytes, const wchar_t *matchPattern, const unsigned char * outBytes);

Memory-to-memory untar. The first file matching a pattern in the MustMatch property is extracted and returned.

Returns TRUE for success, FALSE for failure.

top
UntarFromMemory
int CkTarW_UntarFromMemory(HCkTarW cHandle, const unsigned char * tarFileBytes);

Extracts the files and directories from an in-memory TAR archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property. Returns the number of files and directories extracted, or -1 for failure.

top
UntarFromMemoryAsync (1)
HCkTaskW CkTarW_UntarFromMemoryAsync(HCkTarW cHandle, const unsigned char * tarFileBytes);

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

Returns NULL on failure

top
UntarGz
BOOL CkTarW_UntarGz(HCkTarW cHandle, const wchar_t *tarPath);

Extracts the files and directories from a tar.gz (or tar.gzip) archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
UntarGzAsync (1)
HCkTaskW CkTarW_UntarGzAsync(HCkTarW cHandle, const wchar_t *tarPath);

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

top
UntarZ
BOOL CkTarW_UntarZ(HCkTarW cHandle, const wchar_t *tarPath);

Extracts the files and directories from a tar.Z archive, reconstructing the directory tree(s) in the local filesystem. The files are extracted to the directory specified by the UntarFromDir property.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
UntarZAsync (1)
HCkTaskW CkTarW_UntarZAsync(HCkTarW cHandle, const wchar_t *tarPath);

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

Returns NULL on failure

top
VerifyTar
BOOL CkTarW_VerifyTar(HCkTarW cHandle, const wchar_t *tarPath);

Verifies that a TAR archive is valid. This method opens the TAR archive and scans the entire file by walking the TAR headers. Returns TRUE if no errors were found. Otherwise returns FALSE.

top
VerifyTarAsync (1)
HCkTaskW CkTarW_VerifyTarAsync(HCkTarW cHandle, const wchar_t *tarPath);

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

Returns NULL on failure

top
WriteTar
BOOL CkTarW_WriteTar(HCkTarW cHandle, const wchar_t *tarPath);

Writes a TAR archive. The directory trees previously added by calling AddDirRoot one or more times are included in the output TAR archive.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
WriteTarAsync (1)
HCkTaskW CkTarW_WriteTarAsync(HCkTarW cHandle, const wchar_t *tarPath);

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

Returns NULL on failure

top
WriteTarBz2
BOOL CkTarW_WriteTarBz2(HCkTarW cHandle, const wchar_t *bz2Path);

Writes a .tar.bz2 compressed TAR archive. The directory trees previously added by calling AddDirRoot one or more times are included in the output file.

Returns TRUE for success, FALSE for failure.

top
WriteTarBz2Async (1)
HCkTaskW CkTarW_WriteTarBz2Async(HCkTarW cHandle, const wchar_t *bz2Path);

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

Returns NULL on failure

top
WriteTarGz
BOOL CkTarW_WriteTarGz(HCkTarW cHandle, const wchar_t *gzPath);

Writes a .tar.gz (also known as .tgz) compressed TAR archive. The directory trees previously added by calling AddDirRoot one or more times are included in the output file.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
WriteTarGzAsync (1)
HCkTaskW CkTarW_WriteTarGzAsync(HCkTarW cHandle, const wchar_t *gzPath);

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

Returns NULL on failure

top