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