XmlSchemaCollection::Add Method (String^, String^)
Adds the schema located by the given URL into the schema collection.
Assembly: System.Xml (in System.Xml.dll)
Parameters
- ns
-
Type:
System::String^
The namespace URI associated with the schema. For XML Schemas, this will typically be the targetNamespace.
- uri
-
Type:
System::String^
The URL that specifies the schema to load.
Return Value
Type: System.Xml.Schema::XmlSchema^The XmlSchema added to the schema collection; null if the schema being added is an XDR schema or if there are compilation errors in the schema.
| Exception | Condition |
|---|---|
| XmlException | The schema is not a valid schema. |
If ns has already been associated with another schema in the collection, the schema being added replaces the original schema in the collection. For example, in the following C# code, authors.xsd is removed from the collection and names.xsd is added.
schemaColl.Add("urn:author", "authors.xsd");
schemaColl.Add("urn:author", "names.xsd");
If ns is null and the schema being added is an XML Schema, the Add method uses the targetNamespace defined in the XML Schema to identify the schema in the collection. If the schema being added contains references to other namespaces (through include and import elements or the x-schema attribute), the trust level of the application determines how these other namespaces are resolved. (In the .NET Framework version 1.0, a default XmlUrlResolver was always used).
Fully trusted code: A default XmlUrlResolver with no user credentials is used to resolve any external resources. The schemas for these other namespaces are loaded for validation purposes only. Unlike the original schema, these other schemas are not explicitly added to the schema collection. As a result, they are not accessible using any of the collection methods or properties. If these external resources are located on a network resource that requires authentication, use an overload that takes an XmlResolver as one of its arguments and specify an XmlResolver with the necessary credentials.
Semi-trusted code: External references are not resolved.
Note |
|---|
If the XmlSchemaCollection is being accessed using the XmlValidatingReader::Schemas property, the Add method uses the XmlResolver specified by the XmlValidatingReader::XmlResolver property. |
Important |
|---|
The XmlSchemaCollection class is obsolete in the .NET Framework version 2.0 and has been replaced by the XmlSchemaSet class. |
The following example validates three XML files using schemas stored in the XmlSchemaCollection.
#using <System.dll> #using <System.Xml.dll> using namespace System; using namespace System::IO; using namespace System::Xml; using namespace System::Xml::Schema; public ref class SchemaCollectionSample { private: XmlTextReader^ reader; XmlValidatingReader^ vreader; Boolean m_success; public: SchemaCollectionSample() { reader = nullptr; vreader = nullptr; m_success = true; //Load the schema collection. XmlSchemaCollection^ xsc = gcnew XmlSchemaCollection; String^ schema = "books.xsd"; String^ schema1 = "schema1.xdr"; xsc->Add( "urn:bookstore-schema", schema ); //XSD schema xsc->Add( "urn:newbooks-schema", schema1 ); //XDR schema String^ doc1 = "booksSchema.xml"; String^ doc2 = "booksSchemaFail.xml"; String^ doc3 = "newbooks.xml"; //Validate the files using schemas stored in the collection. Validate( doc1, xsc ); //Should pass. Validate( doc2, xsc ); //Should fail. Validate( doc3, xsc ); //Should fail. } private: void Validate( String^ filename, XmlSchemaCollection^ xsc ) { m_success = true; Console::WriteLine(); Console::WriteLine( "Validating XML file {0}...", filename ); reader = gcnew XmlTextReader( filename ); //Create a validating reader. vreader = gcnew XmlValidatingReader( reader ); //Validate using the schemas stored in the schema collection. vreader->Schemas->Add( xsc ); //Set the validation event handler vreader->ValidationEventHandler += gcnew ValidationEventHandler( this, &SchemaCollectionSample::ValidationCallBack ); //Read and validate the XML data. while ( vreader->Read() ) {} Console::WriteLine( "Validation finished. Validation {0}", (m_success == true ? (String^)"successful" : "failed") ); Console::WriteLine(); //Close the reader. vreader->Close(); } void ValidationCallBack( Object^ /*sender*/, ValidationEventArgs^ args ) { m_success = false; Console::Write( "\r\n\tValidation error: {0}", args->Message ); } }; int main() { gcnew SchemaCollectionSample; }
The sample uses the following five input files:
booksSchema.xml
<?xml version='1.0'?> <bookstore xmlns="urn:bookstore-schema"> <book genre="autobiography"> <title>The Autobiography of Benjamin Franklin</title> <author> <first-name>Benjamin</first-name> <last-name>Franklin</last-name> </author> <price>8.99</price> </book> <book genre="novel"> <title>The Confidence Man</title> <author> <first-name>Herman</first-name> <last-name>Melville</last-name> </author> <price>11.99</price> </book> </bookstore>
booksSchemaFail.xml
<?xml version='1.0'?> <bookstore xmlns="urn:bookstore-schema"> <book> <author> <first-name>Benjamin</first-name> <last-name>Franklin</last-name> </author> </book> <book genre="novel"> <title>The Confidence Man</title> <author> <first-name>Herman</first-name> <last-name>Melville</last-name> </author> <price>11.99</price> </book> <book genre="philosophy"> <title>The Gorgias</title> <author> <name>Plato</name> </author> <price>9.99</price> </book> </bookstore>
newbooks.xml
<?xml version='1.0'?> <bookstore xmlns="urn:newbooks-schema"> <book genre="novel" style="hardcover"> <title>The Handmaid's Tale</title> <author> <first-name>Margaret</first-name> <last-name>Atwood</last-name> </author> <price>19.95</price> </book> <book genre="novel" style="other"> <title>The Poisonwood Bible</title> <author> <first-name>Barbara</first-name> <last-name>Kingsolver</last-name> </author> <price>11.99</price> </book> </bookstore>
books.xsd
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:bookstore-schema" elementFormDefault="qualified" targetNamespace="urn:bookstore-schema"> <xsd:element name="bookstore" type="bookstoreType"/> <xsd:complexType name="bookstoreType"> <xsd:sequence maxOccurs="unbounded"> <xsd:element name="book" type="bookType"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="bookType"> <xsd:sequence> <xsd:element name="title" type="xsd:string"/> <xsd:element name="author" type="authorName"/> <xsd:element name="price" type="xsd:decimal"/> </xsd:sequence> <xsd:attribute name="genre" type="xsd:string"/> </xsd:complexType> <xsd:complexType name="authorName"> <xsd:sequence> <xsd:element name="first-name" type="xsd:string"/> <xsd:element name="last-name" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:schema>
schema1.xdr
<?xml version="1.0"?> <Schema xmlns="urn:schemas-microsoft-com:xml-data" xmlns:dt="urn:schemas-microsoft-com:datatypes"> <ElementType name="first-name" content="textOnly"/> <ElementType name="last-name" content="textOnly"/> <ElementType name="name" content="textOnly"/> <ElementType name="price" content="textOnly" dt:type="fixed.14.4"/> <ElementType name="author" content="eltOnly" order="one"> <group order="seq"> <element type="name"/> </group> <group order="seq"> <element type="first-name"/> <element type="last-name"/> </group> </ElementType> <ElementType name="title" content="textOnly"/> <AttributeType name="genre" dt:type="string"/> <AttributeType name="style" dt:type="enumeration" dt:values="paperback hardcover"/> <ElementType name="book" content="eltOnly"> <attribute type="genre" required="yes"/> <attribute type="style" required="yes"/> <element type="title"/> <element type="author"/> <element type="price"/> </ElementType> <ElementType name="bookstore" content="eltOnly"> <element type="book"/> </ElementType> </Schema>
Available since 1.1

