ftp://ftp.redhat.com/pub/redhat/linux/rawhide/SRPMS/SRPMS/gnome-vfs2-2.3.8-1.src.rpm
[gnome-vfs-httpcaptive.git] / doc / html / gnome-vfs-gnomevfsmetadata.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >Metadata</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK
9 REL="HOME"
10 TITLE="GnomeVFS - Filesystem Abstraction library"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="Advanced Operations"
14 HREF="advanced-operations.html"><LINK
15 REL="PREVIOUS"
16 TITLE="Advanced Operations"
17 HREF="advanced-operations.html"><LINK
18 REL="NEXT"
19 TITLE="Monitoring"
20 HREF="gnome-vfs-gnome-vfs-monitor.html"><META
21 NAME="GENERATOR"
22 CONTENT="GTK-Doc V0.10 (SGML mode)"><STYLE
23 TYPE="text/css"
24 >.synopsis, .classsynopsis {
25     background: #eeeeee;
26     border: solid 1px #aaaaaa;
27     padding: 0.5em;
28 }
29 .programlisting {
30     background: #eeeeff;
31     border: solid 1px #aaaaff;
32     padding: 0.5em;
33 }
34 .variablelist {
35     padding: 4px;
36     margin-left: 3em;
37 }
38 .navigation {
39     background: #ffeeee;
40     border: solid 1px #ffaaaa;
41     margin-top: 0.5em;
42     margin-bottom: 0.5em;
43 }
44 .navigation a {
45     color: #770000;
46 }
47 .navigation a:visited {
48     color: #550000;
49 }
50 .navigation .title {
51     font-size: 200%;
52 }</STYLE
53 ></HEAD
54 ><BODY
55 CLASS="REFENTRY"
56 BGCOLOR="#FFFFFF"
57 TEXT="#000000"
58 LINK="#0000FF"
59 VLINK="#840084"
60 ALINK="#0000FF"
61 ><TABLE
62 WIDTH="100%"
63 CLASS="navigation"
64 SUMMARY="Navigation header"
65 CELLPADDING="2"
66 CELLSPACING="2"
67 ><TR
68 VALIGN="middle"
69 ><TD
70 ><A
71 ACCESSKEY="p"
72 HREF="advanced-operations.html"
73 ><IMG
74 SRC="left.png"
75 WIDTH="24"
76 HEIGHT="24"
77 BORDER="0"
78 ALT="Prev"></A
79 ></TD
80 ><TD
81 ><A
82 ACCESSKEY="u"
83 HREF="advanced-operations.html"
84 ><IMG
85 SRC="up.png"
86 WIDTH="24"
87 HEIGHT="24"
88 BORDER="0"
89 ALT="Up"></A
90 ></TD
91 ><TD
92 ><A
93 ACCESSKEY="h"
94 HREF="index.html"
95 ><IMG
96 SRC="home.png"
97 WIDTH="24"
98 HEIGHT="24"
99 BORDER="0"
100 ALT="Home"></A
101 ></TD
102 ><TH
103 WIDTH="100%"
104 align="center"
105 >GnomeVFS - Filesystem Abstraction library</TH
106 ><TD
107 ><A
108 ACCESSKEY="n"
109 HREF="gnome-vfs-gnome-vfs-monitor.html"
110 ><IMG
111 SRC="right.png"
112 WIDTH="24"
113 HEIGHT="24"
114 BORDER="0"
115 ALT="Next"></A
116 ></TD
117 ></TR
118 ></TABLE
119 ><H1
120 ><A
121 NAME="GNOME-VFS-GNOMEVFSMETADATA"
122 ></A
123 >Metadata</H1
124 ><DIV
125 CLASS="REFNAMEDIV"
126 ><A
127 NAME="AEN3184"
128 ></A
129 ><H2
130 >Name</H2
131 >Metadata&nbsp;--&nbsp;attach extra pieces of information to files, such as icons or positions</DIV
132 ><DIV
133 CLASS="REFSYNOPSISDIV"
134 ><A
135 NAME="AEN3187"
136 ></A
137 ><H2
138 >Synopsis</H2
139 ><PRE
140 CLASS="SYNOPSIS"
141 >&#13;
142
143 #define     <A
144 HREF="gnome-vfs-gnomevfsmetadata.html#GNOME-VFS-METADATA-CONST-CAPS"
145 >GNOME_VFS_METADATA_CONST</A
146 >        (obj)
147 struct      <A
148 HREF="gnome-vfs-gnomevfsmetadata.html#GNOMEVFSMETADATAPRIVATE"
149 >GnomeVfsMetadataPrivate</A
150 >;
151 void        <A
152 HREF="gnome-vfs-gnomevfsmetadata.html#GNOME-VFS-METADATA-SET-STRING"
153 >gnome_vfs_metadata_set_string</A
154 >   (GnomeVfsMetadata *self,
155                                              const char *key,
156                                              const char *value);
157 int         <A
158 HREF="gnome-vfs-gnomevfsmetadata.html#GNOME-VFS-METADATA-GET-INT"
159 >gnome_vfs_metadata_get_int</A
160 >      (GnomeVfsMetadata *self,
161                                              const char *key);
162 void        <A
163 HREF="gnome-vfs-gnomevfsmetadata.html#GNOME-VFS-METADATA-SET-INT"
164 >gnome_vfs_metadata_set_int</A
165 >      (GnomeVfsMetadata *self,
166                                              const char *key,
167                                              gpointer value);
168 GObject*    <A
169 HREF="gnome-vfs-gnomevfsmetadata.html#GNOME-VFS-METADATA-NEW"
170 >gnome_vfs_metadata_new</A
171 >          (const char *uri);&#13;</PRE
172 ></DIV
173 ><DIV
174 CLASS="REFSECT1"
175 ><A
176 NAME="AEN3201"
177 ></A
178 ><H2
179 >Description</H2
180 ><P
181 ></P
182 ></DIV
183 ><DIV
184 CLASS="REFSECT1"
185 ><A
186 NAME="AEN3204"
187 ></A
188 ><H2
189 >Details</H2
190 ><DIV
191 CLASS="REFSECT2"
192 ><A
193 NAME="AEN3206"
194 ></A
195 ><H3
196 ><A
197 NAME="GNOME-VFS-METADATA-CONST-CAPS"
198 ></A
199 >GNOME_VFS_METADATA_CONST()</H3
200 ><PRE
201 CLASS="PROGRAMLISTING"
202 >#define GNOME_VFS_METADATA_CONST(obj)  G_TYPE_CHECK_INSTANCE_CAST((obj), gnome_vfs_metadata_get_type(), GnomeVfsMetadata const)</PRE
203 ><P
204 ></P
205 ><P
206 ></P
207 ><TABLE
208 CLASS="variablelist"
209 BORDER="0"
210 CELLSPACING="0"
211 CELLPADDING="4"
212 ><TBODY
213 ><TR
214 ><TD
215 ALIGN="LEFT"
216 VALIGN="TOP"
217 ><A
218 NAME="AEN3212"><SPAN
219 STYLE="white-space: nowrap"
220 ><TT
221 CLASS="PARAMETER"
222 ><I
223 >obj</I
224 ></TT
225 >&nbsp;:</SPAN
226 ></TD
227 ><TD
228 ALIGN="LEFT"
229 VALIGN="TOP"
230 ><P
231 >&#13;</P
232 ></TD
233 ></TR
234 ></TBODY
235 ></TABLE
236 ></DIV
237 ><HR><DIV
238 CLASS="REFSECT2"
239 ><A
240 NAME="AEN3217"
241 ></A
242 ><H3
243 ><A
244 NAME="GNOMEVFSMETADATAPRIVATE"
245 ></A
246 >struct GnomeVfsMetadataPrivate</H3
247 ><PRE
248 CLASS="PROGRAMLISTING"
249 >struct GnomeVfsMetadataPrivate;</PRE
250 ><P
251 ></P
252 ></DIV
253 ><HR><DIV
254 CLASS="REFSECT2"
255 ><A
256 NAME="AEN3222"
257 ></A
258 ><H3
259 ><A
260 NAME="GNOME-VFS-METADATA-SET-STRING"
261 ></A
262 >gnome_vfs_metadata_set_string ()</H3
263 ><PRE
264 CLASS="PROGRAMLISTING"
265 >void        gnome_vfs_metadata_set_string   (GnomeVfsMetadata *self,
266                                              const char *key,
267                                              const char *value);</PRE
268 ><P
269 ></P
270 ><P
271 ></P
272 ><TABLE
273 CLASS="variablelist"
274 BORDER="0"
275 CELLSPACING="0"
276 CELLPADDING="4"
277 ><TBODY
278 ><TR
279 ><TD
280 ALIGN="LEFT"
281 VALIGN="TOP"
282 ><A
283 NAME="AEN3229"><SPAN
284 STYLE="white-space: nowrap"
285 ><TT
286 CLASS="PARAMETER"
287 ><I
288 >self</I
289 ></TT
290 >&nbsp;:</SPAN
291 ></TD
292 ><TD
293 ALIGN="LEFT"
294 VALIGN="TOP"
295 ><P
296 ></P
297 ></TD
298 ></TR
299 ><TR
300 ><TD
301 ALIGN="LEFT"
302 VALIGN="TOP"
303 ><A
304 NAME="AEN3234"><SPAN
305 STYLE="white-space: nowrap"
306 ><TT
307 CLASS="PARAMETER"
308 ><I
309 >key</I
310 ></TT
311 >&nbsp;:</SPAN
312 ></TD
313 ><TD
314 ALIGN="LEFT"
315 VALIGN="TOP"
316 ><P
317 ></P
318 ></TD
319 ></TR
320 ><TR
321 ><TD
322 ALIGN="LEFT"
323 VALIGN="TOP"
324 ><A
325 NAME="AEN3239"><SPAN
326 STYLE="white-space: nowrap"
327 ><TT
328 CLASS="PARAMETER"
329 ><I
330 >value</I
331 ></TT
332 >&nbsp;:</SPAN
333 ></TD
334 ><TD
335 ALIGN="LEFT"
336 VALIGN="TOP"
337 ><P
338 >&#13;</P
339 ></TD
340 ></TR
341 ></TBODY
342 ></TABLE
343 ></DIV
344 ><HR><DIV
345 CLASS="REFSECT2"
346 ><A
347 NAME="AEN3244"
348 ></A
349 ><H3
350 ><A
351 NAME="GNOME-VFS-METADATA-GET-INT"
352 ></A
353 >gnome_vfs_metadata_get_int ()</H3
354 ><PRE
355 CLASS="PROGRAMLISTING"
356 >int         gnome_vfs_metadata_get_int      (GnomeVfsMetadata *self,
357                                              const char *key);</PRE
358 ><P
359 >Gets the piece of integer metadata associated with <TT
360 CLASS="PARAMETER"
361 ><I
362 >key</I
363 ></TT
364 >.</P
365 ><P
366 ></P
367 ><P
368 ></P
369 ><TABLE
370 CLASS="variablelist"
371 BORDER="0"
372 CELLSPACING="0"
373 CELLPADDING="4"
374 ><TBODY
375 ><TR
376 ><TD
377 ALIGN="LEFT"
378 VALIGN="TOP"
379 ><A
380 NAME="AEN3253"><SPAN
381 STYLE="white-space: nowrap"
382 ><TT
383 CLASS="PARAMETER"
384 ><I
385 >self</I
386 ></TT
387 >&nbsp;:</SPAN
388 ></TD
389 ><TD
390 ALIGN="LEFT"
391 VALIGN="TOP"
392 ><P
393 > Metadata object to get the property of</P
394 ></TD
395 ></TR
396 ><TR
397 ><TD
398 ALIGN="LEFT"
399 VALIGN="TOP"
400 ><A
401 NAME="AEN3258"><SPAN
402 STYLE="white-space: nowrap"
403 ><TT
404 CLASS="PARAMETER"
405 ><I
406 >key</I
407 ></TT
408 >&nbsp;:</SPAN
409 ></TD
410 ><TD
411 ALIGN="LEFT"
412 VALIGN="TOP"
413 ><P
414 > key to retrieve</P
415 ></TD
416 ></TR
417 ><TR
418 ><TD
419 ALIGN="LEFT"
420 VALIGN="TOP"
421 ><A
422 NAME="AEN3263"><SPAN
423 STYLE="white-space: nowrap"
424 ><SPAN
425 CLASS="emphasis"
426 ><I
427 CLASS="EMPHASIS"
428 >Returns</I
429 ></SPAN
430 > :</SPAN
431 ></TD
432 ><TD
433 ALIGN="LEFT"
434 VALIGN="TOP"
435 ><P
436 > the integer associated with <TT
437 CLASS="PARAMETER"
438 ><I
439 >key</I
440 ></TT
441 ></P
442 ></TD
443 ></TR
444 ></TBODY
445 ></TABLE
446 ></DIV
447 ><HR><DIV
448 CLASS="REFSECT2"
449 ><A
450 NAME="AEN3269"
451 ></A
452 ><H3
453 ><A
454 NAME="GNOME-VFS-METADATA-SET-INT"
455 ></A
456 >gnome_vfs_metadata_set_int ()</H3
457 ><PRE
458 CLASS="PROGRAMLISTING"
459 >void        gnome_vfs_metadata_set_int      (GnomeVfsMetadata *self,
460                                              const char *key,
461                                              gpointer value);</PRE
462 ><P
463 ></P
464 ><P
465 ></P
466 ><TABLE
467 CLASS="variablelist"
468 BORDER="0"
469 CELLSPACING="0"
470 CELLPADDING="4"
471 ><TBODY
472 ><TR
473 ><TD
474 ALIGN="LEFT"
475 VALIGN="TOP"
476 ><A
477 NAME="AEN3277"><SPAN
478 STYLE="white-space: nowrap"
479 ><TT
480 CLASS="PARAMETER"
481 ><I
482 >self</I
483 ></TT
484 >&nbsp;:</SPAN
485 ></TD
486 ><TD
487 ALIGN="LEFT"
488 VALIGN="TOP"
489 ><P
490 ></P
491 ></TD
492 ></TR
493 ><TR
494 ><TD
495 ALIGN="LEFT"
496 VALIGN="TOP"
497 ><A
498 NAME="AEN3282"><SPAN
499 STYLE="white-space: nowrap"
500 ><TT
501 CLASS="PARAMETER"
502 ><I
503 >key</I
504 ></TT
505 >&nbsp;:</SPAN
506 ></TD
507 ><TD
508 ALIGN="LEFT"
509 VALIGN="TOP"
510 ><P
511 ></P
512 ></TD
513 ></TR
514 ><TR
515 ><TD
516 ALIGN="LEFT"
517 VALIGN="TOP"
518 ><A
519 NAME="AEN3287"><SPAN
520 STYLE="white-space: nowrap"
521 ><TT
522 CLASS="PARAMETER"
523 ><I
524 >value</I
525 ></TT
526 >&nbsp;:</SPAN
527 ></TD
528 ><TD
529 ALIGN="LEFT"
530 VALIGN="TOP"
531 ><P
532 >&#13;</P
533 ></TD
534 ></TR
535 ></TBODY
536 ></TABLE
537 ></DIV
538 ><HR><DIV
539 CLASS="REFSECT2"
540 ><A
541 NAME="AEN3292"
542 ></A
543 ><H3
544 ><A
545 NAME="GNOME-VFS-METADATA-NEW"
546 ></A
547 >gnome_vfs_metadata_new ()</H3
548 ><PRE
549 CLASS="PROGRAMLISTING"
550 >GObject*    gnome_vfs_metadata_new          (const char *uri);</PRE
551 ><P
552 ></P
553 ><P
554 ></P
555 ><TABLE
556 CLASS="variablelist"
557 BORDER="0"
558 CELLSPACING="0"
559 CELLPADDING="4"
560 ><TBODY
561 ><TR
562 ><TD
563 ALIGN="LEFT"
564 VALIGN="TOP"
565 ><A
566 NAME="AEN3299"><SPAN
567 STYLE="white-space: nowrap"
568 ><TT
569 CLASS="PARAMETER"
570 ><I
571 >uri</I
572 ></TT
573 >&nbsp;:</SPAN
574 ></TD
575 ><TD
576 ALIGN="LEFT"
577 VALIGN="TOP"
578 ><P
579 ></P
580 ></TD
581 ></TR
582 ><TR
583 ><TD
584 ALIGN="LEFT"
585 VALIGN="TOP"
586 ><A
587 NAME="AEN3304"><SPAN
588 STYLE="white-space: nowrap"
589 ><SPAN
590 CLASS="emphasis"
591 ><I
592 CLASS="EMPHASIS"
593 >Returns</I
594 ></SPAN
595 > :</SPAN
596 ></TD
597 ><TD
598 ALIGN="LEFT"
599 VALIGN="TOP"
600 ><P
601 >&#13;</P
602 ></TD
603 ></TR
604 ></TBODY
605 ></TABLE
606 ></DIV
607 ></DIV
608 ><TABLE
609 CLASS="navigation"
610 WIDTH="100%"
611 SUMMARY="Navigation footer"
612 CELLPADDING="2"
613 CELLSPACING="2"
614 ><TR
615 VALIGN="middle"
616 ><TD
617 ALIGN="left"
618 ><A
619 ACCESSKEY="p"
620 HREF="advanced-operations.html"
621 ><B
622 >&lt;&lt;&lt;&nbsp;Advanced Operations</B
623 ></A
624 ></TD
625 ><TD
626 ALIGN="right"
627 ><A
628 ACCESSKEY="n"
629 HREF="gnome-vfs-gnome-vfs-monitor.html"
630 ><B
631 >Monitoring&nbsp;&gt;&gt;&gt;</B
632 ></A
633 ></TD
634 ></TR
635 ></TABLE
636 ></BODY
637 ></HTML
638 >