Interface nsIDirectoryServiceProvider2Type

nsIDirectoryServiceProvider2

An extension of nsIDirectoryServiceProvider which allows multiple files to be returned for the given key.

Hierarchy

Methods

AddRef QueryInterface Release getFile getFiles

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

getFile

  • getFile

    Directory Service calls this when it gets the first request for a prop or on every request if the prop is not persistent.

    Returns

    The file represented by the property.

    Parameters

    • prop: string

      The symbolic name of the file.

    • persistent: boolean

      TRUE - The returned file will be cached by Directory Service. Subsequent requests for this prop will bypass the provider and use the cache. FALSE - The provider will be asked for this prop each time it is requested.

    Returns nsIFile

getFiles

  • getFiles

    Directory Service calls this when it gets a request for a prop and the requested type is nsISimpleEnumerator.

    Returns

    An enumerator for a list of file locations. The elements in the enumeration are nsIFile

    Return Code

    NS_SUCCESS_AGGREGATE_RESULT if this result should be aggregated with other "lower" providers.

    Parameters

    • prop: string

      The symbolic name of the file list.

    Returns nsISimpleEnumerator

Settings

Member Visibility

Theme

Generated using TypeDoc