Interface nsICommandParamsType

Hierarchy

Methods

AddRef QueryInterface Release getBooleanValue getCStringValue getDoubleValue getISupportsValue getLongValue getStringValue getValueType removeValue setBooleanValue setCStringValue setDoubleValue setISupportsValue setLongValue setStringValue

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

getBooleanValue

  • get_Value

    Get the value of a specified parameter. Will return an error if the parameter does not exist, or if the value is of the wrong type (no coercion is performed for you).

    nsISupports values can contain any XPCOM interface, as documented for the command. It is permissible for it to contain nsICommandParams, but not this one (i.e. self-containing is not allowed).

    Parameters

    • name: string

    Returns boolean

getCStringValue

  • Parameters

    • name: string

    Returns string

getDoubleValue

  • Parameters

    • name: string

    Returns number

getISupportsValue

  • Parameters

    • name: string

    Returns nsISupports

getLongValue

  • Parameters

    • name: string

    Returns number

getStringValue

  • Parameters

    • name: string

    Returns string

getValueType

  • getValueType

    Get the type of a specified parameter

    Parameters

    • name: string

    Returns number

removeValue

  • removeValue

    Remove the specified parameter from the list.

    Parameters

    • name: string

    Returns void

setBooleanValue

  • set_Value

    Set the value of a specified parameter (thus creating an entry for it).

    nsISupports values can contain any XPCOM interface, as documented for the command. It is permissible for it to contain nsICommandParams, but not this one (i.e. self-containing is not allowed).

    Parameters

    • name: string
    • value: boolean

    Returns void

setCStringValue

  • Parameters

    • name: string
    • value: string

    Returns void

setDoubleValue

  • Parameters

    • name: string
    • value: number

    Returns void

setISupportsValue

  • Parameters

    • name: string
    • value: nsISupports

    Returns void

setLongValue

  • Parameters

    • name: string
    • value: number

    Returns void

setStringValue

  • Parameters

    • name: string
    • value: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc