[This is preliminary documentation and is subject to change.]
Populate the Mappings hierarchy from an XML Document.
This method can only be called on the root Mappings object or an exception
is raised. It reads all <mapping> elements from the Document to build
the Mappings hierarchy.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public virtual void Populate( XmlDocument doc, XmlElement parent )
Public Overridable Sub Populate ( _ doc As XmlDocument, _ parent As XmlElement _ )
public: virtual void Populate ( XmlDocument^ doc, XmlElement^ parent )
Parameters- doc (XmlDocument)
- A DOM Document that defines one or more <mappings> elements from which to populate the Mappings hierarchy. Note the root Mappings object is a virtual object and therefore not represented by a XmlElement in this Document.
- parent (XmlElement)
- A DOM XmlElement in the source document that should be considered the parent XmlElement of this Mappings object. This parameter is required because the root Mappings object is a virtual object that is not represented in the DOM graph, so some other node usually serves as its parent (e.g. the <agent> node in an AgentConfig configuration file)
Exceptions| Exception | Condition |
|---|---|
| AdkConfigException | AdkConfigException is thrown if a required element or attribute
is missing or has an invalid value
|
| AdkMappingException | AdkMappingException is thrown if this method is called on
a Mappings instance other than the root Mappings container
|