OPC Studio User's Guide and Reference
IEasyDAClientExtension2 Class Members
Fields  Methods 


OpcLabs.EasyOpcClassicCore Assembly > OpcLabs.EasyOpc.DataAccess.Extensions Namespace : IEasyDAClientExtension2 Class

The following tables list the members exposed by IEasyDAClientExtension2.

Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)Default group parameters used in Wait methods. Based on DefaultWaitRequestedUpdateRate.  
Public FieldDefault timeout used in Wait methods. In milliseconds. Equals to System.Threading.Timeout.Infinite (-1).  
Public Fieldstatic (Shared in Visual Basic)Default minimum quality used in Wait methods. Equals to OpcLabs.EasyOpc.DataAccess.DAQualities.GoodNonspecific (192).  
Public FieldDefault requested update rate used in Wait methods. In milliseconds. Equals to 1000 milliseconds (1 second).  
Top
Public Methods
 NameDescription
Public Methodstatic (Shared in Visual Basic)

Browses the nodes in OPC DA server's address space. Starts from the specified node, and returns information about child nodes found.

Browses the nodes in server's address space, given a browse arguments object.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Allows to traverse through OPC DA address space nodes under the specified node, using given browse arguments.  
Public Method (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item Access Rights OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Alarm Area List OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Alarm Quick Help OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Rate of Change Limit OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Contact Close Label OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Condition Logic OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Condition Status OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item Canonical DataType OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Deadband OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item Description OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Deviation Limit OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item EUInfo OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item EU Type OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of EU Units OPC property for a given OPC item.  
Public MethodServes as the default hash function. (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of High EU OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of HiHi Limit OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of High Instrument Range OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Hi Limit OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains a DAItemPropertyRecord structure filled with OPC property values for a given OPC item.

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Limit Exceeded OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Low EU OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Low Instrument Range OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Lo Limit OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of LoLo Limit OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Contact Open Label OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Primary Alarm Area OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of typed OPC property, using descriptor objects for the OPC server, node, and the property.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Boolean.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Byte.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Char.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.DateTime.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Decimal.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Double.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Int16.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Int32.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Int64.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.IntPtr.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.Single.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to an array of System.String.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Boolean.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Byte.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Char.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.DateTime.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Decimal.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains a DAPropertyValueDictionary filled with OPC property values for a given OPC item.

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Double.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Int16.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Int32.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Int64.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.IntPtr.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.Single.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets a value of OPC property, using descriptor object for the OPC server, and an OPC Item ID, and converts it to System.String.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item Quality OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Server Scan Rate OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Sound File OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item Timestamp OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item Timezone OPC property for a given OPC item.  
Public MethodGets the System.Type of the current instance. (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Overloaded. Obtains value of Item Value OPC property for a given OPC item.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a typed named item from an OPC server. A typed value, quality and timestamp are returned.

The ReadItem method uses the first available data from the server; it does not wait until the quality becomes "uncertain" or "good".

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a typed named item from an OPC server. Only the item's typed value is returned (quality and timestamp are not returned).

Use this method if you are only interested in the actual typed value of the OPC item. Use ReadItem method if you also need the quality or timestamp. The ReadItemValue method makes it very easy to obtain the actual typed data value with just one function call.

The ReadItemValue method requires that the value quality is "good".

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Boolean. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Byte. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Char. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.DateTime. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Decimal. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Double. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Int16. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Int32. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Int64. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.IntPtr. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.Single. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to an array of System.String. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Boolean. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Byte. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Char. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.DateTime. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Decimal. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Double. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Int16. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Int32. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Int64. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.IntPtr. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.Single. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Reads a value of named OPC item, and converts it to System.String. The value is requested from the OPC server using a corresponding data type.  
Public Methodstatic (Shared in Visual Basic)Determines whether the client object supports a given OPC technology or technologies (such as OPC COM or OPC XML).  
Public MethodReturns a string that represents the current object. (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Overloaded. Waits until the OPC-DA item quality becomes "good".

This method subscribes to the specified OPC-DA item, and monitors its data until it has "good" quality, an error occurs, or the alloted time elapses.

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Waits until the OPC-DA items satisfy the given conditions.

Subscribes to the specified OPC-DA items, and monitors their data until the predicates specified for each item become true, or the alloted time elapses.

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Waits until the OPC-DA items reach the given minimum quality.

Subscribes to the specified OPC-DA items, and monitors their data until they have at least the quality specified for each item, an error occurs, or the alloted time elapses.

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes into a typed named item in an OPC server. A typed value, quality and timestamp are written.

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a typed value into a (typed) named item in an OPC server. Only the item's typed value is written (quality and timestamp are not written).

The server(s) can be local or can be remotely accessed via DCOM.

 
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Boolean value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Byte value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Char value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Decimal value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Double value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Int16 value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Int32 value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Int64 value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.IntPtr value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.Single value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes an array of System.String value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Boolean value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Byte value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Char value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Decimal value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Double value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Int16 value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Int32 value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Int64 value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.IntPtr value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.Single value into a named OPC item. A corresponding data type is passed to the OPC server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Writes a System.String value into a named OPC item. A corresponding data type is passed to the OPC server.  
Top
Protected Methods
 NameDescription
Protected MethodAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from object)
Protected MethodCreates a shallow copy of the current System.Object. (Inherited from object)
Top
Extension Methods
 NameDescription
Public Extension MethodSets the arbitrary object associated with the node.
Top
See Also

Reference

IEasyDAClientExtension2 Class
OpcLabs.EasyOpc.DataAccess.Extensions Namespace