AdgFactory class | QSYS API Reference Guide

Estimated reading time: 14 minutes

The AdgFactory class static methods construct instances of IAdgObject representing database files, libraries, and members along with IDataArea for data areas.

Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll

Inheritance: Object

Thread Safety

Any public static (Shared) members of this type are safe for multithreaded operations.

Any instance members are not guaranteed to be thread safe.

Properties

Methods

IDataArea NewDataArea(AdgConnection cn, string PathName)

Creates a new instance of the interface with an unknown subtype.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.The subtype of the data area is set to .

IDataArea NewDataArea(AdgConnection cn, string PathName)

Parameters

Returns

IDataArea NewDataArea(AdgConnection cn, string PathName, AdgSubTypes DataAreaType)

Creates a new instance of the interface with a specified subtype.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.The subtype of the data area is set to the value of the parameter.

IDataArea NewDataArea(AdgConnection cn, string PathName, AdgSubTypes DataAreaType)

Parameters

Returns

IDirectory NewDirectory(AdgConnection cn, string PathName)

Creates a new instance of the interface.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.

IDirectory NewDirectory(AdgConnection cn, string PathName)

Parameters

Returns

IFileObject NewFile(AdgConnection cn, string PathName)

Creates a new instance of the interface.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.

IFileObject NewFile(AdgConnection cn, string PathName)

Parameters

Returns

ILibraryList NewLibraryList(AdgConnection cn)

Creates a new instance of the interface.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.

ILibraryList NewLibraryList(AdgConnection cn)

Parameters

Returns

IMember NewMember(AdgConnection cn, string PathName)

Creates a new instance of the interface.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.

IMember NewMember(AdgConnection cn, string PathName)

Parameters

Returns

IAdgObject NewObject(AdgConnection cn, AdgObjectTypes type, string path)

Creates a new instance of the interface.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.

IAdgObject NewObject(AdgConnection cn, AdgObjectTypes type, string path)

Parameters

Returns

ISystemValue NewSystemValue(AdgConnection cn, bool withNewTransaction)

Creates a new instance of the interface.

Remarks

This method uses the method to create a new instance of the interface.The method is a generic method that takes a function delegate as a parameter.The function delegate is responsible for creating the new instance.If the parameter is null, an is thrown.

ISystemValue NewSystemValue(AdgConnection cn, bool withNewTransaction)

Parameters

Returns

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

Returns

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

Returns

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

Returns

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

Returns

IAdgObject Synchronized(IAdgObject adgObj)

Wraps an in a synchronized (thread-safe) wrapper.

Remarks

This method checks the type of the parameter and wraps it in a corresponding synchronized (thread-safe) wrapper.If the object is already a synchronized object, it is returned as is.If the object is an , it is wrapped in a .If the object is an , it is wrapped in a .If the object is an , it is wrapped in a .If the object is an , it is wrapped in a .If the object is none of the above types, it is wrapped in a .

IAdgObject Synchronized(IAdgObject adgObj)

Parameters

Returns

ILibraryList Synchronized(ILibraryList llObj)

Wraps an in a synchronized (thread-safe) wrapper.

Remarks

This method checks if the parameter is already a synchronized object. If it is, the method returns the object as is. If it’s not, the method wraps it in a to ensure thread safety.

ILibraryList Synchronized(ILibraryList llObj)

Parameters

Returns