Interface nsICategoryManagerType

Hierarchy

Methods

AddRef QueryInterface Release addCategoryEntry deleteCategory deleteCategoryEntry enumerateCategories enumerateCategory getCategoryEntry

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

addCategoryEntry

  • Add an entry to a category.

    Returns

    Previous entry, if any

    Parameters

    • aCategory: string

      The name of the category ("protocol")

    • aEntry: string

      The entry to be added ("http")

    • aValue: string

      The value for the entry ("moz.httprulez.1")

    • aPersist: boolean

      Should this data persist between invocations?

    • aReplace: boolean

      Should we replace an existing entry?

    Returns string

deleteCategory

  • Delete a category and all entries.

    Parameters

    • aCategory: string

      The category to be deleted.

    Returns void

deleteCategoryEntry

  • Delete an entry from the category.

    Parameters

    • aCategory: string

      The name of the category ("protocol")

    • aEntry: string

      The entry to be added ("http")

    • aPersist: boolean

      Delete persistent data from registry, if present?

    Returns void

enumerateCategories

  • Enumerate all existing categories

    Returns

    a simple enumerator, each result QIs to nsISupportsCString.

    Returns nsISimpleEnumerator

enumerateCategory

  • Enumerate the entries in a category.

    Returns

    a simple enumerator, each result QIs to nsICategoryEntry.

    Parameters

    • aCategory: string

      The category to be enumerated.

    Returns nsISimpleEnumerator

getCategoryEntry

  • Get the value for the given category's entry.

    Returns

    The value.

    Parameters

    • aCategory: string

      The name of the category ("protocol")

    • aEntry: string

      The entry you're looking for ("http")

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc