Tutorial User Guide > State Table Functional Interface > Overwrite User Response Variable
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Overwrite User Response Variable
AASTATE.overwrite_ur_real
(step_id, variable_name, value)
 
Description:
This function will overwrite a REAL State Table variable called <variable_name> associated with the given step. It differs from the record_ur_real function in that the associated analysis step ID is given explicitly as a call argument. Thus, user responses can be recorded or overwritten for steps that are not the current assigned 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.
REAL
value
This value specifies the value to record for the <variable_name>.
Output:
INTEGER
<Return Value> 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None
Remarks:
None
Example:
None.
  
AASTATE.overwrite_ur_realarray
(step_id, variable_name, num, values)
 
Description:
This function will overwrite an array of State Table variables of REALs called <variable_name> associated with the given step. It differs from the record_ur_integer function in that the associated analysis step ID is given explicitly as a call argument. Thus, user responses can be recorded or overwritten for steps that are not the current assigned 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.
INTEGER
num
This value specifies the number of values to store.
REAL
values(num)
This value specifies the value to record for the <variable_name>.
Output:
INTEGER
<Return Value> 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
None
Example:
None
  
AASTATE.overwrite_ur_integer
(step_id, variable_name, value)
 
Description:
This function will overwrite an INTEGER State Table variable called <variable_name> associated with the given step. It differs from the record_ur_integer function in that the associated analysis step ID is given explicitly as a call argument. Thus, user responses can be recorded or overwritten for steps that are not the current assigned 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.
INTEGER
value
This value specifies the values to record for the <variable_name>.
Output:
INTEGER
<Return Value> 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
None
Example:
None
AASTATE.overwrite_ur_integerarray
(step_id, variable_name, num, values)
 
Description:
This function will overwrite an array of State Table variable of INTEGERs called <variable_name> associated with the given step. It differs from the record_ur_integer function in that the associated analysis step ID is given explicitly as a call argument. Thus, user responses can be recorded or overwritten for steps that are not the current assigned 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.
INTEGER
num
This value specifies the number of values to store.
INTEGER
values(num)
This value specifies the values to record for the <variable_name>.
Output:
INTEGER
<Return Value> 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
None
Example:
None
 
AASTATE.overwrite_ur_string
(step_id, variable_name, value)
 
Description:
This function will overwrite a virtual length STRING called <variable_name> associated with the given step. It differs from the record_ur_string function in that the associated analysis step ID is given explicitly as a call argument. Thus, user responses can be recorded or overwritten for steps that are not the current assigned 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.
STRING
value[virtual]
This value specifies the value to record for the <variable_name>.
Output:
INTEGER
<Return Value> 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
None
Example:
None
 
AASTATE.overwrite_ur_stringarray
(step_id, variable_name, num, values)
 
Description:
This function will overwrite an array of strings called <variable_name> associated with the given step. It differs from the record_ur_integer function in that the associated analysis step ID is given explicitly as a call argument. Thus, user responses can be recorded or overwritten for steps that are not the current assigned 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.
INTEGER
num
This value specifies the number of values to store.
STRING
values[virtual](virtual)
This value specifies the values to record for the <variable_name>.
Output:
INTEGER
<Return Value> 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None
Remarks:
None
Example:
None
 
AASTATE.overwrite_uresponse
(step_id, variable_name, real_val, i_val, str_val, data_type)
 
Description:
This function will overwrite either a real, integer, or string value associated with a specified analysis step. Place holder arguments are given for all three data types. Only one of the value arguments is used based upon the <data_type> argument. This call differs from the record_uresponse call in that the associated analysis step ID is given explicitly as a call argument. Thus, user responses can be recorded or overwritten for steps that are not the current assigned 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
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 to record for the <variable_name>. The other two values will not be accessed.
Error Conditions:
None.
Remarks:
The application author is not expected to prefer this interface call because of its complexity.
Example:
None.