XPInstall API Reference:Install Object:Methods:getComponentFolder

From MDC

Contents 1 getComponentFolder 1.1 Method of 1.2 Syntax 1.3 Parameters 1.4 Returns 1.5 Description

[edit] getComponentFolder

Returns an object representing the directory in which a component is installed.

[edit] Method of

Install object

[edit] Syntax

Object getComponentFolder
   (String registryName);

Object getComponentFolder (
   String registryName,
   String subDirectory);

[edit] Parameters

The getComponentFolder method has these parameters:

registryName

The pathname in the Client Version Registry for the component whose installation directory is to be obtained.

subDirectory

A string that specifies the name of a subdirectory. If the specified subdirectory doesn't exist, it is created. This parameter is available in Netscape 6 and may be case sensitive (depending on the operating system).

[edit] Returns

An object representing the directory in which the component is installed, or NULL if the component could not be found or if subDirectory refers to a file that already exists.

[edit] Description

The getComponentFolder method to find the location of a previously installed software package. Typically, you use this method with the addFile method or the addDirectory method.