Introduction to the DeltaV Excel Add-in

DVRead and DVReadWithStatus Syntax

Syntax

DVRead(parameter path, return type)

DVReadWithStatus (parameter path, return type, status type)

Note

To use the DVReadWithStatus function, you must select two adjacent cells (horizontal or vertical) first.

Parameter Path - is the parameter property to be written to the selected cell. The parameter path's value is read from DeltaV . A parameter path follows the form:

module/[function block]/parameter.property

For example, FIC-101/ADD1/IN1.CV represents the current value (CV) of the IN1 parameter in the ADD1 block of the FIC-101 module.

The formula can use the parameter path or a cell reference of a cell containing the path. If you check Paste parameter path to the left of result box in the Configure Read Function dialog, the resulting formula references the cell where the parameter path exists.

data type - indicates whether you want the value of the parameter returned as a number (DVNumDataType) or as text (DVTextDataType). Text values are typically useful for discrete parameters that have a named value; such as, AUTO, MAN, OFF, ON. If an error occurs, the software returns a #N/A instead of the parameter value, indicating that no data is available. To obtain both the parameter value and the status value (which would return any errors), use the DVReadWithStatus function.

status type - indicates whether you want the call status returned as a word (DVTextStatusType) or a number (DVNumStatusType). If an error occurs, the status value contains the error number or error text, depending on the status type chosen. A 0 status value indicates successful execution. If the software returns a non-zero number, change the status type to text to receive more information on the error.

Note

The Configure Read Function dialog writes the parameter path in uppercase. If you enter the function manually, you must enter the parameter path in uppercase.

Note

DVRead and DVReadWithStatus are volatile MS Excel functions, which means that the functions recalculate every time the worksheet recalculates.