Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIPersistentProperties Interface Reference

import "nsIPersistentProperties2.idl";

Inheritance diagram for nsIPersistentProperties:
Inheritance graph
[legend]
Collaboration diagram for nsIPersistentProperties:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void load (in nsIInputStream input)
 load a set of name/value pairs from the input stream names and values should be in UTF8
void save (in nsIOutputStream output, in AUTF8String header)
 output the values to the stream - results will be in UTF8
void subclass (in nsIPersistentProperties superclass)
 call subclass() to make future calls to load() set the properties in this "superclass" instead
nsISimpleEnumerator enumerate ()
 get an enumeration of nsIPropertyElement objects, which are read-only (i.e.
AString getStringProperty (in AUTF8String key)
 shortcut to nsIProperty's get() which retrieves a string value directly (and thus faster)
AString setStringProperty (in AUTF8String key, in AString value)
 shortcut to nsIProperty's set() which sets a string value directly (and thus faster)
void get (in string prop, in nsIIDRef iid,[iid_is(iid), retval] out nsQIResult result)
 Gets a property with a given name.
void set (in string prop, in nsISupports value)
 Sets a property with a given name to a given value.
boolean has (in string prop)
 Returns true if the property with the given name exists.
void undefine (in string prop)
 Undefines a property.
void getKeys (out PRUint32 count,[array, size_is(count), retval] out string keys)
 Returns an array of the keys.

Detailed Description

Definition at line 52 of file nsIPersistentProperties2.idl.


Member Function Documentation

get an enumeration of nsIPropertyElement objects, which are read-only (i.e.

setting properties on the element will not make changes back into the source nsIPersistentProperties

void nsIProperties::get ( in string  prop,
in nsIIDRef  iid,
[iid_is(iid), retval] out nsQIResult  result 
) [inherited]

Gets a property with a given name.

Returns:
NS_ERROR_FAILURE if a property with that name doesn't exist.
NS_ERROR_NO_INTERFACE if the found property fails to QI to the given iid.

Here is the caller graph for this function:

void nsIProperties::getKeys ( out PRUint32  count,
[array, size_is(count), retval] out string  keys 
) [inherited]

Returns an array of the keys.

Here is the caller graph for this function:

AString nsIPersistentProperties::getStringProperty ( in AUTF8String  key)

shortcut to nsIProperty's get() which retrieves a string value directly (and thus faster)

boolean nsIProperties::has ( in string  prop) [inherited]

Returns true if the property with the given name exists.

Here is the caller graph for this function:

load a set of name/value pairs from the input stream names and values should be in UTF8

void nsIPersistentProperties::save ( in nsIOutputStream  output,
in AUTF8String  header 
)

output the values to the stream - results will be in UTF8

void nsIProperties::set ( in string  prop,
in nsISupports  value 
) [inherited]

Sets a property with a given name to a given value.

Here is the caller graph for this function:

AString nsIPersistentProperties::setStringProperty ( in AUTF8String  key,
in AString  value 
)

shortcut to nsIProperty's set() which sets a string value directly (and thus faster)

call subclass() to make future calls to load() set the properties in this "superclass" instead

void nsIProperties::undefine ( in string  prop) [inherited]

Undefines a property.

Returns:
NS_ERROR_FAILURE if a property with that name doesn't already exist.

Here is the caller graph for this function:


The documentation for this interface was generated from the following file: