XmlSchemaSet.Add Method (String, XmlReader)

 

Adds the XML Schema definition language (XSD) schema contained in the XmlReader to the XmlSchemaSet.

Namespace:   System.Xml.Schema
Assembly:  System.Xml (in System.Xml.dll)

Public Function Add (
	targetNamespace As String,
	schemaDocument As XmlReader
) As XmlSchema

Parameters

targetNamespace
Type: System.String

The schema targetNamespace property, or null to use the targetNamespace specified in the schema.

schemaDocument
Type: System.Xml.XmlReader

The XmlReader object.

Return Value

Type: System.Xml.Schema.XmlSchema

An XmlSchema object if the schema is valid. If the schema is not valid and a ValidationEventHandler is specified, then null is returned and the appropriate validation event is raised. Otherwise, an XmlSchemaException is thrown.

Exception Condition
XmlSchemaException

The schema is not valid.

ArgumentNullException

The XmlReader object passed as a parameter is null.

Before a schema can be added to an XmlSchemaSet, it has to be successfully preprocessed. Preprocessing performs the following basic tasks.

  1. The schema is checked for structural validity according to the rules of W3C XML Schema, but the schema is not fully validated.

  2. References to internal and external schema components are resolved. Any imported or included schemas that are successfully retrieved are also added to the XmlSchemaSet. Imported schemas are added as separate XmlSchema objects, and included schemas are made a part of the including XmlSchema.

The following are important notes to consider when using the Add method.

  • Successfully retrieved schemas imported or included by the schemas contained in the XmlReader are also added to the XmlSchemaSet.

  • If the XmlReader is not positioned on the root element, an XmlSchemaException is thrown unless the current item is an element. If the current item is an xs:schema element, the schema document is read into the XmlSchemaSet; otherwise, an XmlSchemaException is thrown because the schema is not valid.

  • If the XmlReader is positioned over a sequence of XML nodes, only the first node in the sequence is added.

  • If the schema was created from a XmlReader.Create method call, the value of the ProcessInlineSchema property is ignored, because inline schema processing is not applied for W3C XML Schema documents.

  • The XmlResolver property of the XmlReader is not used to resolve references to namespaces or schema locations in include and import elements. Instead, the XmlResolver property of the XmlSchemaSet is used.

  • The Add method of the XmlSchemaSet has the ability to use the target namespace defined in a schema, rather than requiring the target namespace be specified as a parameter when the Add method is called. Specifying null or String.Empty to the Add method instructs the XmlSchemaSet to use the target namespace defined in the schema. For an example of this behavior, see the Add method.

The remaining functionality of this method is identical to that of the Add method.

The following code example adds the books.xsd schema contained in the XmlTextReader with a target namespace of http://www.contoso.com/books to the XmlSchemaSet.

Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()
schemaSet.Add("http://www.contoso.com/books", New XmlTextReader("books.xsd")

.NET Framework
Available since 2.0
Return to top
Show: