Tutorial Toolkit Function Descriptions > Preferences > Database
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Database
 
db_get_pref
(pref_id, data_type, int_pref, log_pref, real_pref, char_pref)
Description:
This function will get a preference from the database.
Input:
INTEGER
pref_id
This value specifies the id value of the preference to be retrieved.
INTEGER
data_type
This value is not used.
Output:
INTEGER
int_pref
This value returns the integer preference value.
LOGICAL
log_pref
This value returns the logical preference value.
REAL
real_pref
This value returns the real preference value.
STRING
char_pref[31]
This value returns the string preference value.
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:
 
13000002
Unrecoverable database error.
13000088
Preference not found.
Remarks:
Accesses one record in the “preference” table in the database.
Example:
Please see db_get_pref (p. 1384) in the MSC Acumen Toolkit - Code Example.
 
db_add_pref
(id, data_type, int_pref, log_pref, real_pref, name)
Description:
Adds preferences to the database.
Input:
INTEGER
id
The internal id of the preference to be added to the database
INTEGER
data_type
The data type of the preference to be added to the database
INTEGER
int_pref
The value of the integer preference to be added to the database
INTEGER
log_pref
The value of the logical preference to be added to the database
REAL
real_pref
The value of the real preference to be added to the database
STRING
name[31]
The value of the character preference to be added to the database
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason
Error Conditions:
 
13000088
Preference not found
13000002
Unrecoverable database error
Remarks:
Accesses one record in the “preference” table in the database.
Example:
Please see db_add_pref (p. 1382) in the MSC Acumen Toolkit - Code Example.