ab340ec8843cae9de58582c1ab030de1e1bc05f0
[platform/upstream/libzip.git] / man / zip_source_tell_write.man
1 .TH "ZIP_SOURCE_TELL_WRITE" "3" "November 18, 2014" "NiH" "Library Functions Manual"
2 .nh
3 .if n .ad l
4 .SH "NAME"
5 \fBzip_source_tell_write\fR
6 \- report current write offset in zip source
7 .SH "LIBRARY"
8 libzip (-lzip)
9 .SH "SYNOPSIS"
10 \fB#include <zip.h>\fR
11 .sp
12 \fIzip_int64_t\fR
13 .PD 0
14 .HP 4n
15 \fBzip_source_tell_write\fR(\fIzip_source_t\ *source\fR);
16 .PD
17 .SH "DESCRIPTION"
18 The function
19 \fBzip_source_tell_write\fR()
20 returns the current write offset
21 for
22 \fIsource\fR.
23 The return value can be passed to
24 zip_source_seek_write(3)
25 with
26 \fIwhence\fR
27 set to
28 \fRSEEK_SET\fR
29 to return to the same location in the source.
30 .SH "RETURN VALUES"
31 Upon successful completion the current write offset is returned.
32 Otherwise, \-1 is returned and the error information in
33 \fIsource\fR
34 is set to indicate the error.
35 .SH "SEE ALSO"
36 libzip(3),
37 zip_source(3),
38 zip_source_begin_write(3),
39 zip_source_commit_write(3),
40 zip_source_rollback_write(3),
41 zip_source_tell_write(3),
42 zip_source_write(3)
43 .SH "AUTHORS"
44 Dieter Baron <\fIdillo@nih.at\fR>
45 and
46 Thomas Klausner <\fItk@giga.or.at\fR>