Interface nsISFVDictionaryType

nsISFVDictionary represents nsISFVDictionary structured header value.

Hierarchy

Methods

AddRef QueryInterface Release delete get parseMore serialize set

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

delete

  • Remove the key-value pair equivalent to key.

    Throws

    NS_ERROR_UNEXPECTED upon attempt to delete key that does not exist in parameters.

    Parameters

    • key: string

    Returns void

get

  • Return value (nsISFVItemOrInnerList) stored for key, if it is present. QueryInterface can be used on a value to get more specific type.

    Throws

    NS_ERROR_UNEXPECTED if the key does not exist in parameters.

    Parameters

    • key: string

    Returns nsISFVItemOrInnerList

parseMore

  • In case when header value is split across lines, it's possible this method parses supplied line and merges it with members of existing object.

    Parameters

    • header: string

    Returns void

serialize

set

  • Insert a new key-value pair. If an equivalent key already exists: the key remains and retains in its place in the order, its corresponding value is updated with the new value.

    Throws

    NS_ERROR_UNEXPECTED if supplied item does not implement nsISFVItemOrInnerList interface.

    Parameters

    • key: string
    • member_value: nsISFVItemOrInnerList

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc