Tutorial User Guide > State Table Functional Interface > Retrieve User Response Variable
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Retrieve User Response Variable
AASTATE.get_ur_real
(step_id, variable_name, value, null_flag)
Description:
This function will retrieve a real State Table variable called <variable_name> associated with the given step.
Input:
STRING
step_id[4]
This value specifies the step id.
STRING
variable_name[4096]
This value specifies the name of the user response variable.
Output:
REAL
value
This value specifies the value retrieved for the <variable_name>.
INTEGER
null_flag
This value specifies whether data was returned for this variable. If null_flag = 0, then a value was returned. If null_flag = 1 then no value was returned.
Error Conditions:
None.
Remarks:
None
Example:
None
 
AASTATE.get_ur_realarray
(step_id, variable_name, num, values)
 
Description:
This function will retrieve an array of real values State Table called <variable_name> associated with the given step. The size of the array will be allocated by this function.
Input:
STRING
step_id[4]
This value specifies the step id.
STRING
variable_name[4096]
This value specifies the name of the user response variable.
Output:
INTEGER
num
This value specifies the number of values returned.
REAL
values(VIRTUAL)
This value specifies the values retrieved for the <variable_name>. The size of this array will be allocated by this function.
Error Conditions:
None.
Remarks:
None.
Example:
None
  
AASTATE.get_ur_integer
(step_id, variable_name, value, null_flag)
 
Description:
This function will retrieve an integer State Table variable called <variable_name> associated with the given step.
Input:
STRING
step_id[4]
This value specifies the step id.
STRING
variable_name[4096]
This value specifies the name of the user response variable.
Output:
INTEGER
value
This value specifies the value to record for the <variable_name>.
INTEGER
null_flag
This value specifies whether data was returned for this variable. If null_flag = 0, then a value was returned. If null_flag = 1 then no value was returned.
Error Conditions:
None
Remarks:
None
Example:
None
 
AASTATE.get_ur_integerarray
(step_id, variable_name, num, values)
 
Description:
This function will retrieve an array of integer State Table values called <variable_name> associated with the given step. The size of the array will be allocated by this function.
Input:
STRING
step_id[4]
This value specifies the step id.
STRING
variable_name[4096]
This value specifies the name of the user response variable.
Output:
INTEGER
num
This value specifies the number of values returned.
INTEGER
values(VIRTUAL)
This value specifies the values retrieved for the <variable_name>. The size of this array will be allocated by this function.
Error Conditions:
None.
Remarks:
None
Example:
None
  
AASTATE.get_ur_string
(step_id, variable_name, value, null_flag)
 
Description:
This function will retrieve a virtual length string called <variable_name> associated with the given step.
Input:
STRING
step_id[4]
This value specifies the step id.
STRING
variable_name[4096]
This value specifies the name of the user response variable.
Output:
STRING
value[virtual]
This value specifies the value to record for the <variable_name>.
INTEGER
null_flag
This value specifies whether data was returned for this variable. If null_flag = 0, then a value was returned. If null_flag = 1 then no value was returned.
Error Conditions:
None
Remarks:
None.
Example:
None
 
AASTATE.get_ur_stringarray
(step_id, variable_name, num, values)
 
Description:
This function will retrieve an array of strings called <variable_name> associated with the given step. The size of the array will be allocated by this function.
Input:
STRING
step_id[4]
This value specifies the step id.
STRING
variable_name[4096]
This value specifies the name of the user response variable.
Output:
INTEGER
num
This value specifies the number of values returned.
STRING
values[virtual](VIRTUAL)
This value specifies the values retrieved for the <variable_name>. The size of this array will be allocated by this function.
Error Conditions:
None.
Remarks:
None.
Example:
None
AASTATE.get_uresponse
(step_id, variable_name, real_val, i_val, str_val, data_type, null_flag)
 
Description:
This function will retrieve either a real, integer, or string value associated with a specified analysis step. Place holder arguments are given for all three data types. Output is written to only one of the place holder arguments depending upon the data_type value that is returned.
Input:
STRING
step_id[4]
This value specifies the step id.
STRING
variable_name[4096]
This value specifies the name of the user response variable.
Output:
REAL
real_val
This value returns the real value if <data_type> = 1.
INTEGER
i_val
This value returns the integer value if <data_type> = 2.
STRING
str_val[virtual]
This value returns the string value if the <data_type> = 3.
INTEGER
data_type
Flag for type of data retrieved for <variable_name>. The other two values will not be accessed.
INTEGER
null_flag
This value returns whether data was returned for this variable. If null_flag = 0, then a value was returned. If null_flag = 1 then no value was returned.
Error Conditions:
None.
Remarks:
The application author is not expected to favor this interface call because of its complexity. The automated link rule processing software uses this call as the most efficient method for obtaining values for evaluating conditionals. However, by storing state table variables to a dummy step id, this call can be used to retrieve values from the state table without knowing the variable type.
Example:
None.