Interface nsIProfileMigratorType

Migrate application settings from an outside source.

Provider

Application (Profile-migration code)

Client

Toolkit (Startup code)

Obtainable

service, contractid("@mozilla.org/toolkit/profile-migrator;1")

Hierarchy

Methods

AddRef QueryInterface Release migrate

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

migrate

  • Migrate data from an outside source, if possible. Does nothing otherwise.

    When this method is called, a default profile has been created; XPCOM has been initialized such that compreg.dat is in the profile; the directory service does not return a key for NS_APP_USER_PROFILE_50_DIR or any of the keys depending on an active profile. To figure out the directory of the "current" profile, use aStartup.directory.

    If your migrator needs to access services that use the profile (to set profile prefs or bookmarks, for example), use aStartup.doStartup.

    Note

    The startup code ignores COM exceptions thrown from this method.

    Parameters

    • aStartup: nsIProfileStartup

      nsIProfileStartup object to use during migration.

    • aKey: string

      optional key of a migrator to use to skip source selection.

    • aProfileName: string

      optional name of the profile to use for migration.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc