Initial revision
[TestXSLT.git] / libxml2 / doc / html / libxml-xmlschemastypes.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >xmlschemastypes</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK
9 REL="HOME"
10 TITLE="Gnome XML Library Reference Manual"
11 HREF="book1.html"><LINK
12 REL="UP"
13 TITLE="Libxml Library Reference"
14 HREF="libxml-lib.html"><LINK
15 REL="PREVIOUS"
16 TITLE="xmlschemas"
17 HREF="libxml-xmlschemas.html"><LINK
18 REL="NEXT"
19 TITLE="schemasInternals"
20 HREF="libxml-schemasinternals.html"></HEAD
21 ><BODY
22 CLASS="REFENTRY"
23 BGCOLOR="#FFFFFF"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 WIDTH="100%"
32 BORDER="0"
33 BGCOLOR="#000000"
34 CELLPADDING="1"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="4"
39 ALIGN="center"
40 ><FONT
41 COLOR="#FFFFFF"
42 SIZE="5"
43 >Gnome XML Library Reference Manual</FONT
44 ></TH
45 ></TR
46 ><TR
47 ><TD
48 WIDTH="25%"
49 BGCOLOR="#C00000"
50 ALIGN="left"
51 ><A
52 HREF="libxml-xmlschemas.html"
53 ><FONT
54 COLOR="#FFFFFF"
55 SIZE="3"
56 ><B
57 >&#60;&#60;&#60; Previous Page</B
58 ></FONT
59 ></A
60 ></TD
61 ><TD
62 WIDTH="25%"
63 BGCOLOR="#0000C0"
64 ALIGN="center"
65 ><FONT
66 COLOR="#FFFFFF"
67 SIZE="3"
68 ><B
69 ><A
70 HREF="book1.html"
71 ><FONT
72 COLOR="#FFFFFF"
73 SIZE="3"
74 ><B
75 >Home</B
76 ></FONT
77 ></A
78 ></B
79 ></FONT
80 ></TD
81 ><TD
82 WIDTH="25%"
83 BGCOLOR="#00C000"
84 ALIGN="center"
85 ><FONT
86 COLOR="#FFFFFF"
87 SIZE="3"
88 ><B
89 ><A
90 HREF="libxml-lib.html"
91 ><FONT
92 COLOR="#FFFFFF"
93 SIZE="3"
94 ><B
95 >Up</B
96 ></FONT
97 ></A
98 ></B
99 ></FONT
100 ></TD
101 ><TD
102 WIDTH="25%"
103 BGCOLOR="#C00000"
104 ALIGN="right"
105 ><A
106 HREF="libxml-schemasinternals.html"
107 ><FONT
108 COLOR="#FFFFFF"
109 SIZE="3"
110 ><B
111 >Next Page &#62;&#62;&#62;</B
112 ></FONT
113 ></A
114 ></TD
115 ></TR
116 ></TABLE
117 ></DIV
118 ><H1
119 ><A
120 NAME="LIBXML-XMLSCHEMASTYPES">xmlschemastypes</H1
121 ><DIV
122 CLASS="REFNAMEDIV"
123 ><A
124 NAME="AEN31621"
125 ></A
126 ><H2
127 >Name</H2
128 >xmlschemastypes&nbsp;--&nbsp;</DIV
129 ><DIV
130 CLASS="REFSYNOPSISDIV"
131 ><A
132 NAME="AEN31624"><H2
133 >Synopsis</H2
134 ><TABLE
135 BORDER="0"
136 BGCOLOR="#D6E8FF"
137 WIDTH="100%"
138 CELLPADDING="6"
139 ><TR
140 ><TD
141 ><PRE
142 CLASS="SYNOPSIS"
143 >&#13;
144
145 void        <A
146 HREF="libxml-xmlschemastypes.html#XMLSCHEMAINITTYPES"
147 >xmlSchemaInitTypes</A
148 >              (void);
149 void        <A
150 HREF="libxml-xmlschemastypes.html#XMLSCHEMACLEANUPTYPES"
151 >xmlSchemaCleanupTypes</A
152 >           (void);
153 <A
154 HREF="libxml-schemasinternals.html#XMLSCHEMATYPEPTR"
155 >xmlSchemaTypePtr</A
156 > <A
157 HREF="libxml-xmlschemastypes.html#XMLSCHEMAGETPREDEFINEDTYPE"
158 >xmlSchemaGetPredefinedType</A
159 > (const <A
160 HREF="libxml-tree.html#XMLCHAR"
161 >xmlChar</A
162 > *name,
163                                              const <A
164 HREF="libxml-tree.html#XMLCHAR"
165 >xmlChar</A
166 > *ns);
167 int         <A
168 HREF="libxml-xmlschemastypes.html#XMLSCHEMAVALIDATEPREDEFINEDTYPE"
169 >xmlSchemaValidatePredefinedType</A
170 > (<A
171 HREF="libxml-schemasinternals.html#XMLSCHEMATYPEPTR"
172 >xmlSchemaTypePtr</A
173 > type,
174                                              const <A
175 HREF="libxml-tree.html#XMLCHAR"
176 >xmlChar</A
177 > *value,
178                                              <A
179 HREF="libxml-schemasinternals.html#XMLSCHEMAVALPTR"
180 >xmlSchemaValPtr</A
181 > *val);
182 int         <A
183 HREF="libxml-xmlschemastypes.html#XMLSCHEMAVALIDATEFACET"
184 >xmlSchemaValidateFacet</A
185 >          (<A
186 HREF="libxml-schemasinternals.html#XMLSCHEMATYPEPTR"
187 >xmlSchemaTypePtr</A
188 > base,
189                                              <A
190 HREF="libxml-schemasinternals.html#XMLSCHEMAFACETPTR"
191 >xmlSchemaFacetPtr</A
192 > facet,
193                                              const <A
194 HREF="libxml-tree.html#XMLCHAR"
195 >xmlChar</A
196 > *value,
197                                              <A
198 HREF="libxml-schemasinternals.html#XMLSCHEMAVALPTR"
199 >xmlSchemaValPtr</A
200 > val);
201 void        <A
202 HREF="libxml-xmlschemastypes.html#XMLSCHEMAFREEVALUE"
203 >xmlSchemaFreeValue</A
204 >              (<A
205 HREF="libxml-schemasinternals.html#XMLSCHEMAVALPTR"
206 >xmlSchemaValPtr</A
207 > val);</PRE
208 ></TD
209 ></TR
210 ></TABLE
211 ></DIV
212 ><DIV
213 CLASS="REFSECT1"
214 ><A
215 NAME="AEN31644"
216 ></A
217 ><H2
218 >Description</H2
219 ><P
220 ></P
221 ></DIV
222 ><DIV
223 CLASS="REFSECT1"
224 ><A
225 NAME="AEN31647"
226 ></A
227 ><H2
228 >Details</H2
229 ><DIV
230 CLASS="REFSECT2"
231 ><A
232 NAME="AEN31649"
233 ></A
234 ><H3
235 ><A
236 NAME="XMLSCHEMAINITTYPES"
237 ></A
238 >xmlSchemaInitTypes ()</H3
239 ><TABLE
240 BORDER="0"
241 BGCOLOR="#D6E8FF"
242 WIDTH="100%"
243 CELLPADDING="6"
244 ><TR
245 ><TD
246 ><PRE
247 CLASS="PROGRAMLISTING"
248 >void        xmlSchemaInitTypes              (void);</PRE
249 ></TD
250 ></TR
251 ></TABLE
252 ><P
253 ></P
254 ></DIV
255 ><HR><DIV
256 CLASS="REFSECT2"
257 ><A
258 NAME="AEN31654"
259 ></A
260 ><H3
261 ><A
262 NAME="XMLSCHEMACLEANUPTYPES"
263 ></A
264 >xmlSchemaCleanupTypes ()</H3
265 ><TABLE
266 BORDER="0"
267 BGCOLOR="#D6E8FF"
268 WIDTH="100%"
269 CELLPADDING="6"
270 ><TR
271 ><TD
272 ><PRE
273 CLASS="PROGRAMLISTING"
274 >void        xmlSchemaCleanupTypes           (void);</PRE
275 ></TD
276 ></TR
277 ></TABLE
278 ><P
279 >Cleanup the default XML Schemas type library</P
280 ><P
281 ></P
282 ></DIV
283 ><HR><DIV
284 CLASS="REFSECT2"
285 ><A
286 NAME="AEN31660"
287 ></A
288 ><H3
289 ><A
290 NAME="XMLSCHEMAGETPREDEFINEDTYPE"
291 ></A
292 >xmlSchemaGetPredefinedType ()</H3
293 ><TABLE
294 BORDER="0"
295 BGCOLOR="#D6E8FF"
296 WIDTH="100%"
297 CELLPADDING="6"
298 ><TR
299 ><TD
300 ><PRE
301 CLASS="PROGRAMLISTING"
302 ><A
303 HREF="libxml-schemasinternals.html#XMLSCHEMATYPEPTR"
304 >xmlSchemaTypePtr</A
305 > xmlSchemaGetPredefinedType (const <A
306 HREF="libxml-tree.html#XMLCHAR"
307 >xmlChar</A
308 > *name,
309                                              const <A
310 HREF="libxml-tree.html#XMLCHAR"
311 >xmlChar</A
312 > *ns);</PRE
313 ></TD
314 ></TR
315 ></TABLE
316 ><P
317 >Lookup a type in the default XML Schemas type library</P
318 ><P
319 ></P
320 ><DIV
321 CLASS="INFORMALTABLE"
322 ><A
323 NAME="AEN31669"><P
324 ></P
325 ><TABLE
326 BORDER="0"
327 WIDTH="100%"
328 BGCOLOR="#FFD0D0"
329 CELLSPACING="0"
330 CELLPADDING="4"
331 CLASS="CALSTABLE"
332 ><TBODY
333 ><TR
334 ><TD
335 WIDTH="20%"
336 ALIGN="RIGHT"
337 VALIGN="TOP"
338 ><TT
339 CLASS="PARAMETER"
340 ><I
341 >name</I
342 ></TT
343 >&nbsp;:</TD
344 ><TD
345 WIDTH="80%"
346 ALIGN="LEFT"
347 VALIGN="TOP"
348 > the type name</TD
349 ></TR
350 ><TR
351 ><TD
352 WIDTH="20%"
353 ALIGN="RIGHT"
354 VALIGN="TOP"
355 ><TT
356 CLASS="PARAMETER"
357 ><I
358 >ns</I
359 ></TT
360 >&nbsp;:</TD
361 ><TD
362 WIDTH="80%"
363 ALIGN="LEFT"
364 VALIGN="TOP"
365 >  the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"</TD
366 ></TR
367 ><TR
368 ><TD
369 WIDTH="20%"
370 ALIGN="RIGHT"
371 VALIGN="TOP"
372 ><SPAN
373 CLASS="emphasis"
374 ><I
375 CLASS="EMPHASIS"
376 >Returns</I
377 ></SPAN
378 > :</TD
379 ><TD
380 WIDTH="80%"
381 ALIGN="LEFT"
382 VALIGN="TOP"
383 >the type if found, NULL otherwise</TD
384 ></TR
385 ></TBODY
386 ></TABLE
387 ><P
388 ></P
389 ></DIV
390 ></DIV
391 ><HR><DIV
392 CLASS="REFSECT2"
393 ><A
394 NAME="AEN31686"
395 ></A
396 ><H3
397 ><A
398 NAME="XMLSCHEMAVALIDATEPREDEFINEDTYPE"
399 ></A
400 >xmlSchemaValidatePredefinedType ()</H3
401 ><TABLE
402 BORDER="0"
403 BGCOLOR="#D6E8FF"
404 WIDTH="100%"
405 CELLPADDING="6"
406 ><TR
407 ><TD
408 ><PRE
409 CLASS="PROGRAMLISTING"
410 >int         xmlSchemaValidatePredefinedType (<A
411 HREF="libxml-schemasinternals.html#XMLSCHEMATYPEPTR"
412 >xmlSchemaTypePtr</A
413 > type,
414                                              const <A
415 HREF="libxml-tree.html#XMLCHAR"
416 >xmlChar</A
417 > *value,
418                                              <A
419 HREF="libxml-schemasinternals.html#XMLSCHEMAVALPTR"
420 >xmlSchemaValPtr</A
421 > *val);</PRE
422 ></TD
423 ></TR
424 ></TABLE
425 ><P
426 >Check that a value conforms to the lexical space of the predefined type.
427 if true a value is computed and returned in <TT
428 CLASS="PARAMETER"
429 ><I
430 >val</I
431 ></TT
432 >.</P
433 ><P
434 ></P
435 ><DIV
436 CLASS="INFORMALTABLE"
437 ><A
438 NAME="AEN31696"><P
439 ></P
440 ><TABLE
441 BORDER="0"
442 WIDTH="100%"
443 BGCOLOR="#FFD0D0"
444 CELLSPACING="0"
445 CELLPADDING="4"
446 CLASS="CALSTABLE"
447 ><TBODY
448 ><TR
449 ><TD
450 WIDTH="20%"
451 ALIGN="RIGHT"
452 VALIGN="TOP"
453 ><TT
454 CLASS="PARAMETER"
455 ><I
456 >type</I
457 ></TT
458 >&nbsp;:</TD
459 ><TD
460 WIDTH="80%"
461 ALIGN="LEFT"
462 VALIGN="TOP"
463 > the predefined type</TD
464 ></TR
465 ><TR
466 ><TD
467 WIDTH="20%"
468 ALIGN="RIGHT"
469 VALIGN="TOP"
470 ><TT
471 CLASS="PARAMETER"
472 ><I
473 >value</I
474 ></TT
475 >&nbsp;:</TD
476 ><TD
477 WIDTH="80%"
478 ALIGN="LEFT"
479 VALIGN="TOP"
480 > the value to check</TD
481 ></TR
482 ><TR
483 ><TD
484 WIDTH="20%"
485 ALIGN="RIGHT"
486 VALIGN="TOP"
487 ><TT
488 CLASS="PARAMETER"
489 ><I
490 >val</I
491 ></TT
492 >&nbsp;:</TD
493 ><TD
494 WIDTH="80%"
495 ALIGN="LEFT"
496 VALIGN="TOP"
497 >  the return computed value</TD
498 ></TR
499 ><TR
500 ><TD
501 WIDTH="20%"
502 ALIGN="RIGHT"
503 VALIGN="TOP"
504 ><SPAN
505 CLASS="emphasis"
506 ><I
507 CLASS="EMPHASIS"
508 >Returns</I
509 ></SPAN
510 > :</TD
511 ><TD
512 WIDTH="80%"
513 ALIGN="LEFT"
514 VALIGN="TOP"
515 >0 if this validates, a positive error code number otherwise
516 and -1 in case of internal or API error.</TD
517 ></TR
518 ></TBODY
519 ></TABLE
520 ><P
521 ></P
522 ></DIV
523 ></DIV
524 ><HR><DIV
525 CLASS="REFSECT2"
526 ><A
527 NAME="AEN31717"
528 ></A
529 ><H3
530 ><A
531 NAME="XMLSCHEMAVALIDATEFACET"
532 ></A
533 >xmlSchemaValidateFacet ()</H3
534 ><TABLE
535 BORDER="0"
536 BGCOLOR="#D6E8FF"
537 WIDTH="100%"
538 CELLPADDING="6"
539 ><TR
540 ><TD
541 ><PRE
542 CLASS="PROGRAMLISTING"
543 >int         xmlSchemaValidateFacet          (<A
544 HREF="libxml-schemasinternals.html#XMLSCHEMATYPEPTR"
545 >xmlSchemaTypePtr</A
546 > base,
547                                              <A
548 HREF="libxml-schemasinternals.html#XMLSCHEMAFACETPTR"
549 >xmlSchemaFacetPtr</A
550 > facet,
551                                              const <A
552 HREF="libxml-tree.html#XMLCHAR"
553 >xmlChar</A
554 > *value,
555                                              <A
556 HREF="libxml-schemasinternals.html#XMLSCHEMAVALPTR"
557 >xmlSchemaValPtr</A
558 > val);</PRE
559 ></TD
560 ></TR
561 ></TABLE
562 ><P
563 >Check a value against a facet condition</P
564 ><P
565 ></P
566 ><DIV
567 CLASS="INFORMALTABLE"
568 ><A
569 NAME="AEN31727"><P
570 ></P
571 ><TABLE
572 BORDER="0"
573 WIDTH="100%"
574 BGCOLOR="#FFD0D0"
575 CELLSPACING="0"
576 CELLPADDING="4"
577 CLASS="CALSTABLE"
578 ><TBODY
579 ><TR
580 ><TD
581 WIDTH="20%"
582 ALIGN="RIGHT"
583 VALIGN="TOP"
584 ><TT
585 CLASS="PARAMETER"
586 ><I
587 >base</I
588 ></TT
589 >&nbsp;:</TD
590 ><TD
591 WIDTH="80%"
592 ALIGN="LEFT"
593 VALIGN="TOP"
594 >&nbsp;</TD
595 ></TR
596 ><TR
597 ><TD
598 WIDTH="20%"
599 ALIGN="RIGHT"
600 VALIGN="TOP"
601 ><TT
602 CLASS="PARAMETER"
603 ><I
604 >facet</I
605 ></TT
606 >&nbsp;:</TD
607 ><TD
608 WIDTH="80%"
609 ALIGN="LEFT"
610 VALIGN="TOP"
611 >  the facet to check</TD
612 ></TR
613 ><TR
614 ><TD
615 WIDTH="20%"
616 ALIGN="RIGHT"
617 VALIGN="TOP"
618 ><TT
619 CLASS="PARAMETER"
620 ><I
621 >value</I
622 ></TT
623 >&nbsp;:</TD
624 ><TD
625 WIDTH="80%"
626 ALIGN="LEFT"
627 VALIGN="TOP"
628 >  the lexical repr of the value to validate</TD
629 ></TR
630 ><TR
631 ><TD
632 WIDTH="20%"
633 ALIGN="RIGHT"
634 VALIGN="TOP"
635 ><TT
636 CLASS="PARAMETER"
637 ><I
638 >val</I
639 ></TT
640 >&nbsp;:</TD
641 ><TD
642 WIDTH="80%"
643 ALIGN="LEFT"
644 VALIGN="TOP"
645 >  the precomputed value</TD
646 ></TR
647 ><TR
648 ><TD
649 WIDTH="20%"
650 ALIGN="RIGHT"
651 VALIGN="TOP"
652 ><SPAN
653 CLASS="emphasis"
654 ><I
655 CLASS="EMPHASIS"
656 >Returns</I
657 ></SPAN
658 > :</TD
659 ><TD
660 WIDTH="80%"
661 ALIGN="LEFT"
662 VALIGN="TOP"
663 >0 if the element is schemas valid, a positive error code
664 number otherwise and -1 in case of internal or API error.</TD
665 ></TR
666 ></TBODY
667 ></TABLE
668 ><P
669 ></P
670 ></DIV
671 ></DIV
672 ><HR><DIV
673 CLASS="REFSECT2"
674 ><A
675 NAME="AEN31752"
676 ></A
677 ><H3
678 ><A
679 NAME="XMLSCHEMAFREEVALUE"
680 ></A
681 >xmlSchemaFreeValue ()</H3
682 ><TABLE
683 BORDER="0"
684 BGCOLOR="#D6E8FF"
685 WIDTH="100%"
686 CELLPADDING="6"
687 ><TR
688 ><TD
689 ><PRE
690 CLASS="PROGRAMLISTING"
691 >void        xmlSchemaFreeValue              (<A
692 HREF="libxml-schemasinternals.html#XMLSCHEMAVALPTR"
693 >xmlSchemaValPtr</A
694 > val);</PRE
695 ></TD
696 ></TR
697 ></TABLE
698 ><P
699 >Cleanup the default XML Schemas type library</P
700 ><P
701 ></P
702 ><DIV
703 CLASS="INFORMALTABLE"
704 ><A
705 NAME="AEN31759"><P
706 ></P
707 ><TABLE
708 BORDER="0"
709 WIDTH="100%"
710 BGCOLOR="#FFD0D0"
711 CELLSPACING="0"
712 CELLPADDING="4"
713 CLASS="CALSTABLE"
714 ><TBODY
715 ><TR
716 ><TD
717 WIDTH="20%"
718 ALIGN="RIGHT"
719 VALIGN="TOP"
720 ><TT
721 CLASS="PARAMETER"
722 ><I
723 >val</I
724 ></TT
725 >&nbsp;:</TD
726 ><TD
727 WIDTH="80%"
728 ALIGN="LEFT"
729 VALIGN="TOP"
730 >&nbsp;</TD
731 ></TR
732 ></TBODY
733 ></TABLE
734 ><P
735 ></P
736 ></DIV
737 ></DIV
738 ></DIV
739 ><DIV
740 CLASS="NAVFOOTER"
741 ><BR
742 CLEAR="all"><BR><TABLE
743 WIDTH="100%"
744 BORDER="0"
745 BGCOLOR="#000000"
746 CELLPADDING="1"
747 CELLSPACING="0"
748 ><TR
749 ><TD
750 WIDTH="25%"
751 BGCOLOR="#C00000"
752 ALIGN="left"
753 ><A
754 HREF="libxml-xmlschemas.html"
755 ><FONT
756 COLOR="#FFFFFF"
757 SIZE="3"
758 ><B
759 >&#60;&#60;&#60; Previous Page</B
760 ></FONT
761 ></A
762 ></TD
763 ><TD
764 WIDTH="25%"
765 BGCOLOR="#0000C0"
766 ALIGN="center"
767 ><FONT
768 COLOR="#FFFFFF"
769 SIZE="3"
770 ><B
771 ><A
772 HREF="book1.html"
773 ><FONT
774 COLOR="#FFFFFF"
775 SIZE="3"
776 ><B
777 >Home</B
778 ></FONT
779 ></A
780 ></B
781 ></FONT
782 ></TD
783 ><TD
784 WIDTH="25%"
785 BGCOLOR="#00C000"
786 ALIGN="center"
787 ><FONT
788 COLOR="#FFFFFF"
789 SIZE="3"
790 ><B
791 ><A
792 HREF="libxml-lib.html"
793 ><FONT
794 COLOR="#FFFFFF"
795 SIZE="3"
796 ><B
797 >Up</B
798 ></FONT
799 ></A
800 ></B
801 ></FONT
802 ></TD
803 ><TD
804 WIDTH="25%"
805 BGCOLOR="#C00000"
806 ALIGN="right"
807 ><A
808 HREF="libxml-schemasinternals.html"
809 ><FONT
810 COLOR="#FFFFFF"
811 SIZE="3"
812 ><B
813 >Next Page &#62;&#62;&#62;</B
814 ></FONT
815 ></A
816 ></TD
817 ></TR
818 ><TR
819 ><TD
820 COLSPAN="2"
821 ALIGN="left"
822 ><FONT
823 COLOR="#FFFFFF"
824 SIZE="3"
825 ><B
826 >xmlschemas</B
827 ></FONT
828 ></TD
829 ><TD
830 COLSPAN="2"
831 ALIGN="right"
832 ><FONT
833 COLOR="#FFFFFF"
834 SIZE="3"
835 ><B
836 >schemasInternals</B
837 ></FONT
838 ></TD
839 ></TR
840 ></TABLE
841 ></DIV
842 ></BODY
843 ></HTML
844 >