DailyValueRule(Param, DailyValueCode)
Gets the daily value for a given daily value rule and parameter.
Purpose
This function gets the daily value for a given daily value rule and parameter.
Syntax
double DailyValueRule(string Param, string DailyValueCode)Return Value
If the code is successful, the script displays the daily value of the specified analysis parameter for the given daily value rule as a double.
Note: This capability is used in Analysis forms and is designed for equations.
Arguments
| Parameter | Description |
|---|---|
Param |
Optional. The string containing the name of the parameter whose daily value is to be returned. |
DailyValueCode |
Optional. The string containing the code of a DailyValueRule whose value is to be returned. If this argument is missing, the function uses the daily value rule of the current analysis object. |
DailyValueRule example
This example returns the daily value of the current parameter for DailyValueRule.
Dim DV As Double = DailyValueRule( )This example returns the daily value of the current parameter for a daily value rule whose code is CANADA.
double dvr = DailyValueRule("", "CANADA");