Tcl Preference File Management

The Tcl preference file management library module has the file name prefs.tcl. This module contains procedures that read and write preference files

A preference file is a Tcl source code file containing only set commands. These files are loaded into a running Tcl program using the source command.

Here is a list of procedures in this module:

- prefsave
- prefload

# Module Dependencies

No other modules are required in order to use this module

# Module Definition Files

This module requires no definition files.

# Module Procedures

## prefsave

    Declaration  : proc prefsave {filename arrayname}
    Parameters   :
          Name   : filename
          Type   : string
    Description  : preference path/file name

          Name   : arrayname
          Type   : array
    Description  : array name

    Returns      : 1 upon success, 0 otherwise

This procedure will write the array name contents to the preference path/file name.

## prefload

    Declaration  : proc prefload {filename}
    Parameters   :
          Name   : filename
          Type   : string
    Description  : preference path/file name

    Returns      : 1 upon success, 0 otherwise

This procedure will load the preference path/file name.

Goto Top | Tcl Applications | Tcl Software Overview | Tcl Library Overview
| Future Lab Home | Contact Webmaster | Feedback

Copyright © 2006 Future Lab, Last Updated Jul 01, 2006