Ubuntu Platform API  1.0.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
archive.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Ricardo Mendoza <ricardo.mendoza@canonical.com>
17  * Thomas Voß <thomas.voss@canonical.com>
18  */
19 
20 #ifndef UBUNTU_APPLICATION_ARCHIVE_H_
21 #define UBUNTU_APPLICATION_ARCHIVE_H_
22 
23 #include <ubuntu/status.h>
24 #include <ubuntu/visibility.h>
25 
26 #include <stdint.h>
27 #include <stddef.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 typedef struct UbuntuApplicationArchive_ UApplicationArchive;
34 
41 UBUNTU_DLL_PUBLIC UApplicationArchive*
42 u_application_archive_new();
43 
50 UBUNTU_DLL_PUBLIC void
51 u_application_archive_destroy(
52  UApplicationArchive *archive);
53 
61 UBUNTU_DLL_PUBLIC UStatus
62 u_application_archive_write(
63  UApplicationArchive *archive,
64  int64_t s);
65 
74 UBUNTU_DLL_PUBLIC UStatus
75 u_application_archive_write_stringn(
76  UApplicationArchive *archive,
77  const char *s,
78  size_t size);
79 
88 UBUNTU_DLL_PUBLIC UStatus
89 u_application_archive_write_wstringn(
90  UApplicationArchive *archive,
91  const wchar_t *s,
92  size_t size);
93 
102 UBUNTU_DLL_PUBLIC UStatus
103 u_application_archive_write_bytes(
104  UApplicationArchive *archive,
105  const intptr_t *data,
106  size_t size);
107 
108 UBUNTU_DLL_PUBLIC UStatus
109 u_application_archive_write_begin_blockn(
110  UApplicationArchive* archive,
111  const char *name,
112  size_t size);
113 
114 UBUNTU_DLL_PUBLIC UStatus
115 u_application_archive_write_end_blockn(
116  UApplicationArchive* archive,
117  const char *name,
118  size_t size);
119 
127 UBUNTU_DLL_PUBLIC UStatus
128 u_application_archive_read(
129  const UApplicationArchive *archive,
130  int64_t *s);
131 
140 UBUNTU_DLL_PUBLIC UStatus
141 u_application_archive_read_stringn(
142  const UApplicationArchive *archive,
143  const char **s,
144  size_t *size);
145 
154 UBUNTU_DLL_PUBLIC UStatus
155 u_application_archive_read_wstringn(
156  UApplicationArchive *archive,
157  const wchar_t *s,
158  size_t size);
159 
168 UBUNTU_DLL_PUBLIC UStatus
169 u_application_archive_read_bytes(
170  UApplicationArchive *archive,
171  const intptr_t *data,
172  size_t size);
173 
174 #ifdef __cplusplus
175 }
176 #endif
177 
178 #endif /* UBUNTU_APPLICATION_ARCHIVE_H_ */