Interface nsICommandLineValidatorType

Validates arguments on the command line of an XUL application.

Each validator is registered in the category "command-line-validator". 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, validator with ordinary priority should begin with "m".

Example: Category Entry Value command-line-validator b-browser @mozilla.org/browser/clh;1 command-line-validator m-edit @mozilla.org/composer/clh;1 command-line-validator m-irc @mozilla.org/chatzilla/clh;1

Hierarchy

Methods

AddRef QueryInterface Release validate

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

validate

  • Process the command-line validators in the proper order, calling "validate()" on each.

    Throws

    NS_ERROR_ABORT if any validator throws NS_ERROR_ABORT. All other errors thrown by validators will be silently ignored.

    Parameters

    • aCommandLine: nsICommandLine

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc