getWinProfile

(Windows only)

Constructs an object for working with a Windows .ini file.

Method of

Install

Syntax

 WinProfile getWinProfile (
   Object folder,
   String file);

Parameters

The getWinProfile method has the following parameters:

folder	An object representing a directory. You create this object by passing a string representing the directory to the getFolder method.
file	A relative pathname to an initialization file in the directory specified by the folder parameter, such as "royal/royal.ini".

Returns

A WinProfile object.

Description

The getWinProfile method creates an object for manipulating the contents of a Windows .ini file. Once you have this object, you can call its methods to retrieve strings from the file or to add strings to the file. For information on the returned object, see WinProfile.

This method returns null on Unix and Macintosh platforms.

Example

To edit the win.ini file, you would create a WinProfile object with this call:

 var myWinProfileObj = 
   getWinProfile (getFolder("Windows"), "win.ini");