RTI_IDE_CFG function [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== RTI_IDE_CFG function  ======


 
==== Description ====
 
Manages access and updates to configuration records used throughout OpenInsight 10.  The RTI_IDE_CFG_EQUATES insert defines the locations for the value(s) as well as the default values.

**Note:** Developers/users are recommended to always use the EQUated values for accessing/updating the configuration record (as found in the RTI_IDE_CFG_EQUATES insert) rather than absolute position numbers, as locations inside the configuration record are subject to change.
 
==== Syntax ====
 
//rslt// = **RTI_IDE_CFG**(//method//, //param1//, //param2//, //param3//, //param4//, //param5//, //param6//)
 
==== Parameters ====
 
The RTI_IDE_CFG function supports the following values for the //method// parameter:

^Method^Description^Parameters^Return Value^
|CLEARINSTANCECFG|Remove all configuration information for all IDE instances|None|True if successful, false otherwise.  Errors are returned via set_status|
|CLEARMRU|Removes all items from the MRU and flushes it to disk|None|True if successful, false otherwise.  Errors are returned via set_status|
|DELAPP|Removes all IDE config records for an application being deleted|Param1: AppID of the application to be deleted. Defaults to @appid<1>|The number of records deleted|
|DEPLOY|Convenience method, combining CLEARMRU, CLEARINSTANCECFG, and FLUSH calls|None|None|
|FLUSH|Writes the cached config information to disk|Param1: @FM delimited list of fields to flush. If not specified, all fields are flushed|True if successful, false otherwise.  Errors are returned via set_status|
|GETCOLORSET|Returns an @fm delimited array of color values|Param1: Colorset Index\\ Param2: Flags\\ Param3: Reset color|@FM delimited array of color values in the format\\ <colorref> ":" <colorname>|
|GETDIALOG|Returns the name of an IDE common dialog|Param1: Dialog type.  Values include\\ IDE_CFG_GETDLG_T_NEWENT$: New Entity dialog\\ IDE_CFG_GETDLG_T_OPENENT$: Open Entity dialog\\ IDE_CFG_GETDLG_T_OPENREC$: Open Record dialog|ID of common dialog requested|
|GETINSTANCECFG|Returns the config data for a single instance, identified by an instance index.|Param1: instanceIdx, identifying the instance data to retrieve|True if configuration information exists for the specified instance, false otherwise.  Errors are returned via set_status.  Instance information is returned in param2 with the following structure:\\ <1> Position info\\ <2> EAST docksite info\\ <3> WEST docksite info\\ <4> SOUTH docksite info\\ <5> DSN docksite info\\ <6> Undocked DSN info\\ <7> Undocked toolpanel info|
|GETMRU|Returns the MRU information as an AMV array|None|MRU information with the following structure:\\ <1> @vm'd list of DSN IDs\\ <2> @vm'd list of entity keys for the DSN|
|GETQE|Returns the current QuickEvent configuration record|None|An amalgamation of app-specific quickevent config records|
|GETQETYPES|Returns the QuickEvent Types configuration record|None|The QuickEvent Types record|
|GETVALUE|Retrieves a value from the IDE configuration information|Param1: ValueID, identifying the value to retrieve\\ Param2: Default value to use if configuration value is null|Retrieved value.  Errors are returned via set_status|
|LOADDEFAULTS|Resets entire configuration to default, making sure to wipe out any saved instance data|None|True if successful, false otherwise|
|PURGE|Deletes all cached config information|None|True if successful, false otherwise. Errors are returned via set_status|
|RELOADMRU|Re-reads the MRU info from the disk and applies it to the cache.|None|True if successful, false otherwise|
|RESET|Reloads configuration values from default config record|None|True if successful, false otherwise|
|SETINSTANCECFG|Updates the config data for a single instance, identified by an instance index.|Param1: instanceIdx, identifying the instance data to set\\ Param2: instanceCfg data array.  This has the following structure:\\ <1> Position info\\ <2> EAST docksite info\\ <3> WEST docksite info\\ <4> SOUTH docksite info\\ <5> DSN docksite info\\ <6> Undocked DSN info\\ <7> Undocked toolpanel info|True if successful, false otherwise.  Errors are returned via set_status|
|SETVALUE|Sets a value in the IDE configuration information|Param1: ValueID, identifying the value to set\\ Param2: The value to set\\ Param3: NoFlush flag - if true, do NOT flush the changed direct to disk\\Param4: If true, update default value with this value|None.  Errors are returned via set_status|
|UPDATEMRU|Updates the MRU list and flushes it to disk|Param1 : DSN ID to add to the MRU list\\ Param2 : DSN entity ID to add to the MRU list\\ Param3 : If TRUE$ then this is a DELETE operation\\ Param4 : If TRUE$ then add the entity to the update history|The updated MRU list.  Errors are returned via set_status|


==== Example ====
 
<code>
* Get the IP address for the OI 10 console engine server, using the default value if no value is currently defined
ip_address = rti_ide_cfg("GETVALUE", IDE_CFG_POS_CONSOLE_ESERVER_URL$, IDE_CFG_DEF_CONSOLE_ESERVER_URL$)
</code>

<code>
* set the size and position information for the CTO/AREV64 window
call rti_ide_cfg("SETVALUE", IDE_CFG_POS_CTO_SIZE$, do.max:@SVM:size)
</code>