Interface nsICommandLineHandlerType

Handles arguments on the command line of an XUL application.

Each handler is registered in the category "command-line-handler". The entries in this category are read in alphabetical order, and each category value is treated as a service contractid implementing this interface.

By convention, handler with ordinary priority should begin with "m".

Example: Category Entry Value command-line-handler c-extensions @mozilla.org/extension-manager/clh;1 command-line-handler m-edit @mozilla.org/composer/clh;1 command-line-handler m-irc @mozilla.org/chatzilla/clh;1 command-line-handler y-final @mozilla.org/browser/clh-final;1

Note

What do we do about localizing helpInfo? Do we make each handler do it, or provide a generic solution of some sort? Don't freeze this interface without thinking about this!

Hierarchy

Properties

helpInfo: string

When the app is launched with the --help argument, this attribute is retrieved and displayed to the user (on stdout). The text should have embedded newlines which wrap at 76 columns, and should include a newline at the end. By convention, the right column which contains flag descriptions begins at the 24th character.

Methods

  • 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

  • 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

  • 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

  • Process a command line. If this handler finds arguments that it understands, it should perform the appropriate actions (such as opening a window), and remove the arguments from the command-line array.

    Throw

    NS_ERROR_ABORT to immediately cease command-line handling (if this is STATE_INITIAL_LAUNCH, quits the app). All other exceptions are silently ignored.

    Parameters

    • aCommandLine: nsICommandLine

    Returns void

Generated using TypeDoc