diff options
| author | Tim Kientzle <kientzle@acm.org> | 2012-05-29 13:08:34 -0700 |
|---|---|---|
| committer | Tim Kientzle <kientzle@acm.org> | 2012-05-29 13:08:34 -0700 |
| commit | aceae78232e864a97c8c36e798bbb072c4901fae (patch) | |
| tree | 2296c589979bd1897dc1aa822f3654a420264bb5 /libarchive/archive_write_free.3 | |
| parent | c6d3cd33aecdc579966c3fbe7b9424cea83c7555 (diff) | |
| download | libarchive-aceae78232e864a97c8c36e798bbb072c4901fae.tar.gz | |
Add archive_write_fail() utility to force a write
handle to abort prematurely.
Diffstat (limited to 'libarchive/archive_write_free.3')
| -rw-r--r-- | libarchive/archive_write_free.3 | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/libarchive/archive_write_free.3 b/libarchive/archive_write_free.3 index ac01dd4b..1b2d0713 100644 --- a/libarchive/archive_write_free.3 +++ b/libarchive/archive_write_free.3 @@ -28,6 +28,7 @@ .Dt ARCHIVE_WRITE_FREE 3 .Os .Sh NAME +.Nm archive_write_fail , .Nm archive_write_close , .Nm archive_write_finish , .Nm archive_write_free @@ -37,6 +38,8 @@ Streaming Archive Library (libarchive, -larchive) .Sh SYNOPSIS .In archive.h .Ft int +.Fn archive_write_fail "struct archive *" +.Ft int .Fn archive_write_close "struct archive *" .Ft int .Fn archive_write_finish "struct archive *" @@ -44,6 +47,16 @@ Streaming Archive Library (libarchive, -larchive) .Fn archive_write_free "struct archive *" .Sh DESCRIPTION .Bl -tag -width indent +.It Fn archive_write_fail +Always returns +.Cm ARCHIVE_FATAL . +This marks the archive object as being unusable; +after calling this function, the only call that can succeed is +.Fn archive_write_free +to release the resources. +This can be used to speed recovery when the archive creation +must be aborted. +Note that the created archive is likely to be malformed in this case; .It Fn archive_write_close Complete the archive and invoke the close callback. .It Fn archive_write_finish |