1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="AsMetadata">
<refmeta>
<refentrytitle role="top_of_page" id="AsMetadata.top_of_page">AsMetadata</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
APPSTREAM Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AsMetadata</refname>
<refpurpose>Parser for AppStream metadata</refpurpose>
</refnamediv>
<refsect1 id="AsMetadata.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AsMetadata"><returnvalue>AsMetadata</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-metadata-new">as_metadata_new</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GQuark"><returnvalue>GQuark</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-metadata-error-quark">as_metadata_error_quark</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsComponent"><returnvalue>AsComponent</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-metadata-parse-file">as_metadata_parse_file</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsComponent"><returnvalue>AsComponent</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-metadata-parse-data">as_metadata_parse_data</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-metadata-set-locale">as_metadata_set_locale</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-metadata-get-locale">as_metadata_get_locale</link> <phrase role="c_punctuation">()</phrase></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsMetadata.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsMetadataError">AsMetadataError</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="AS-METADATA-ERROR:CAPS">AS_METADATA_ERROR</link></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsMetadata.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen> <link linkend="GObject">GObject</link>
<phrase role="lineart">╰──</phrase> AsMetadata
</screen>
</refsect1>
<refsect1 id="AsMetadata.includes"><title>Includes</title><synopsis>#include <appstream.h>
</synopsis></refsect1>
<refsect1 id="AsMetadata.description" role="desc">
<title role="desc.title">Description</title>
<para>This object parses AppStream metadata, including AppStream
upstream metadata, which is defined by upstream projects.
It returns an <link linkend="AsComponent"><type>AsComponent</type></link> of the data.</para>
<para>See also: <link linkend="AsComponent"><type>AsComponent</type></link>, <link linkend="AsDatabase"><type>AsDatabase</type></link></para>
</refsect1>
<refsect1 id="AsMetadata.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-metadata-new" role="function">
<title>as_metadata_new ()</title>
<indexterm zone="as-metadata-new"><primary>as_metadata_new</primary></indexterm>
<programlisting language="C"><link linkend="AsMetadata"><returnvalue>AsMetadata</returnvalue></link> *
as_metadata_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="AsMetadata"><type>AsMetadata</type></link>.</para>
<refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsMetadata"><type>AsMetadata</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-metadata-error-quark" role="function">
<title>as_metadata_error_quark ()</title>
<indexterm zone="as-metadata-error-quark"><primary>as_metadata_error_quark</primary></indexterm>
<programlisting language="C"><link linkend="GQuark"><returnvalue>GQuark</returnvalue></link>
as_metadata_error_quark (<parameter><type>void</type></parameter>);</programlisting>
<refsect3 role="returns">
<title>Returns</title>
<para> An error quark.</para>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-metadata-parse-file" role="function">
<title>as_metadata_parse_file ()</title>
<indexterm zone="as-metadata-parse-file"><primary>as_metadata_parse_file</primary></indexterm>
<programlisting language="C"><link linkend="AsComponent"><returnvalue>AsComponent</returnvalue></link> *
as_metadata_parse_file (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>,
<parameter><link linkend="GFile"><type>GFile</type></link> *infile</parameter>,
<parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>Parses an AppStream upstream metadata file.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>metad</para></entry>
<entry role="parameter_description"><para>A valid <link linkend="AsMetadata"><type>AsMetadata</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>infile</para></entry>
<entry role="parameter_description"><para><link linkend="GFile"><type>GFile</type></link> for the upstream metadata</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para>A <link linkend="GError"><type>GError</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the <link linkend="AsComponent"><type>AsComponent</type></link> of this file, or NULL on error. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-metadata-parse-data" role="function">
<title>as_metadata_parse_data ()</title>
<indexterm zone="as-metadata-parse-data"><primary>as_metadata_parse_data</primary></indexterm>
<programlisting language="C"><link linkend="AsComponent"><returnvalue>AsComponent</returnvalue></link> *
as_metadata_parse_data (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *data</parameter>,
<parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>Parses AppStream upstream metadata.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>metad</para></entry>
<entry role="parameter_description"><para>A valid <link linkend="AsMetadata"><type>AsMetadata</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>data</para></entry>
<entry role="parameter_description"><para>XML data describing a component</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para>A <link linkend="GError"><type>GError</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the <link linkend="AsComponent"><type>AsComponent</type></link> of this data, or NULL on error. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-metadata-set-locale" role="function">
<title>as_metadata_set_locale ()</title>
<indexterm zone="as-metadata-set-locale"><primary>as_metadata_set_locale</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_metadata_set_locale (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *locale</parameter>);</programlisting>
<para>Sets the current locale which should be used when parsing metadata.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>metad</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsMetadata"><type>AsMetadata</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>locale</para></entry>
<entry role="parameter_description"><para>the locale.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-metadata-get-locale" role="function">
<title>as_metadata_get_locale ()</title>
<indexterm zone="as-metadata-get-locale"><primary>as_metadata_get_locale</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
as_metadata_get_locale (<parameter><link linkend="AsMetadata"><type>AsMetadata</type></link> *metad</parameter>);</programlisting>
<para>Gets the currently used locale.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>metad</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsMetadata"><type>AsMetadata</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> Locale used for metadata parsing.</para>
<para></para>
</refsect3></refsect2>
</refsect1>
<refsect1 id="AsMetadata.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AsMetadataError" role="enum">
<title>enum AsMetadataError</title>
<indexterm zone="AsMetadataError"><primary>AsMetadataError</primary></indexterm>
<para>The error type.</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-METADATA-ERROR-FAILED:CAPS">AS_METADATA_ERROR_FAILED</para></entry>
<entry role="enum_member_description"><para>Generic failure</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-METADATA-ERROR-LAST:CAPS">AS_METADATA_ERROR_LAST</para></entry>
<entry role="enum_member_description"></entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="AS-METADATA-ERROR:CAPS" role="macro">
<title>AS_METADATA_ERROR</title>
<indexterm zone="AS-METADATA-ERROR:CAPS"><primary>AS_METADATA_ERROR</primary></indexterm>
<programlisting language="C">#define AS_METADATA_ERROR as_metadata_error_quark ()
</programlisting>
<para>
</para>
</refsect2>
</refsect1>
</refentry>
|
