AdgFactory.ReadXml Method
Estimated reading time: 5 minutes
Definition
Namespace: ASNA.DataGate.Client
Assembly: ASNA.QSys.DataGate.Client.dll
Reads an XML document and creates a new instance of the interface.
Overloads
| Signature | Description |
|---|---|
| ReadXml(IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, string docObjectNewName, XmlReader reader, XmlOptions options, XmlCancelEventHandler observer)) | Reads an XML document and creates a new instance of the interface. |
| ReadXml(IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, string docObjectNewName, XmlReader reader, XmlOptions options)) | Reads an XML document and creates a new instance of the interface. |
| ReadXml(IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, XmlReader reader, XmlOptions options, XmlCancelEventHandler observer)) | Reads an XML document and creates a new instance of the interface. |
| ReadXml(IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, XmlReader reader, XmlOptions options)) | Reads an XML document and creates a new instance of the interface. |
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, string docObjectNewName, XmlReader reader, XmlOptions options, XmlCancelEventHandler observer)
Reads an XML document and creates a new instance of the interface.
Remarks
This method uses the method to read an XML document and create a new instance of the interface.The method takes several parameters, including an , a container path, an object type, a new object name, an , an , and an .If the parameter is null, an is thrown.
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, string docObjectNewName, XmlReader reader, XmlOptions options, XmlCancelEventHandler observer)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | cn | The to use for the operation. |
| String | containerPath | The path of the container for the object. |
| AdgObjectTypes | docObjectType | The type of the object to create. |
| String | docObjectNewName | The new name for the object, or null to use the existing name. |
| XmlReader | reader | The to use to read the XML document. |
| XmlOptions | options | The to use when reading the XML document. |
| XmlCancelEventHandler | observer | An optional to observe the reading process. |
Returns
| Type | Description |
|---|---|
| IAdgObject | A new instance of the interface. |
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, string docObjectNewName, XmlReader reader, XmlOptions options)
Reads an XML document and creates a new instance of the interface.
Remarks
This method is a convenience overload of the ReadXml method that does not require an parameter.It calls the ReadXml method with the provided parameters and a null .If the parameter is null, an is thrown.
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, string docObjectNewName, XmlReader reader, XmlOptions options)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | cn | The to use for the operation. |
| String | containerPath | The path of the container for the object. |
| AdgObjectTypes | docObjectType | The type of the object to create. |
| String | docObjectNewName | The new name for the object. |
| XmlReader | reader | The to use to read the XML document. |
| XmlOptions | options | The to use when reading the XML document. |
Returns
| Type | Description |
|---|---|
| IAdgObject | A new instance of the interface. |
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, XmlReader reader, XmlOptions options, XmlCancelEventHandler observer)
Reads an XML document and creates a new instance of the interface.
Remarks
This method is a convenience overload of the ReadXml method that does not require a new object name parameter.It calls the ReadXml method with the provided parameters and a null new object name.If the parameter is null, an is thrown.
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, XmlReader reader, XmlOptions options, XmlCancelEventHandler observer)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | cn | The to use for the operation. |
| String | containerPath | The path of the container for the object. |
| AdgObjectTypes | docObjectType | The type of the object to create. |
| XmlReader | reader | The to use to read the XML document. |
| XmlOptions | options | The to use when reading the XML document. |
| XmlCancelEventHandler | observer | An optional to observe the reading process. |
Returns
| Type | Description |
|---|---|
| IAdgObject | A new instance of the interface. |
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, XmlReader reader, XmlOptions options)
Reads an XML document and creates a new instance of the interface.
Remarks
This method is a convenience overload of the ReadXml method that does not require a new object name or an parameter.It calls the ReadXml method with the provided parameters, a null new object name, and a null .If the parameter is null, an is thrown.
IAdgObject ReadXml(AdgConnection cn, string containerPath, AdgObjectTypes docObjectType, XmlReader reader, XmlOptions options)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgConnection | cn | The to use for the operation. |
| String | containerPath | The path of the container for the object. |
| AdgObjectTypes | docObjectType | The type of the object to create. |
| XmlReader | reader | The to use to read the XML document. |
| XmlOptions | options | The to use when reading the XML document. |
Returns
| Type | Description |
|---|---|
| IAdgObject | A new instance of the interface. |