Description

Saves all settings, or a group of related settings, to a settings file. For example:

Session.SaveSettings rcSettings, rcOverwrite, "C:\Mypath\Myfile.rsf"

Arguments

Type Argument type: Enumeration
Specifies which settings to save. If there are no settings of the specified type, no file is created (but no error results). The values are:

rcSettings

Saves all settings.

rcKeyMap

Saves settings relating to keyboard and mouse mapping.

rcToolbar

Saves settings relating to the toolbar.

rcColors

Saves settings relating to color configuration.

rcHotspots

Saves settings relating to hotspot configuration.

rcMenus

Saves settings relating to menu configuration.

rcMainframeXferFile

Saves settings relating to 3270 file transfer. Note: Using this value is equivalent to creating a Transfer Request (.mto) file using the Save button in the File Transfer dialog box.

rcAs400XferFile

Saves settings relating to 5250 file transfer. Note: Using this value is equivalent to creating a Transfer Request (.xto) file using the Save button in the File Transfer dialog box.

rcSettingsUpdate

Saves those settings that have been changed from Reflection defaults, and creates a settings update file.

rcXMLSettingsFile

Saves settings in XML format.

rcRWebSettingsFile

Saves settings to a Reflection for the Web configuration file.

rcLayout

Saves a layout file that can be used to open all currently running sessions. (Untitled sessions are not included in the saved layout.)

ExistsOption Argument type: Enumeration
Specifies actions to take if the specified file name already exists:

rcAskUser

Prompts the user to either overwrite the existing file or cancel the save. An error results if the user then chooses cancel.

rcOverwrite

Replaces the existing file with a new settings file.

rcOpenError

Causes SaveSettings to return an error.

Filename Argument type: String
The file to which settings are saved. Use one of the following extensions if you want the file to appear in the Open Settings File dialog box:

Extension	Settings Type
.rsf	Complete settings file
.map	Keyboard and mouse settings
.btp	Toolbar settings
.clr	Color settings
.hsp	Hotspot and hotlist settings
.mnu	Menu settings
.rsu	Settings update
.xml	XML format
.config	Reflection for the Web format

The file is saved to the current directory unless you provide path information.

$image\jump.gif$ Keyword Index

$image\popup.gif$ Related Topics

$image\popup.gif$ Reflection products that use this command