xpcom/ds/nsIProperties.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
     2 /* This Source Code Form is subject to the terms of the Mozilla Public
     3  * License, v. 2.0. If a copy of the MPL was not distributed with this
     4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     6 #include "nsISupports.idl"
     8 /*
     9  * Simple mapping service interface.
    10  */
    12 [scriptable, uuid(78650582-4e93-4b60-8e85-26ebd3eb14ca)]
    13 interface nsIProperties : nsISupports
    14 {
    15     /**
    16      * Gets a property with a given name. 
    17      *
    18      * @throws NS_ERROR_FAILURE if a property with that name doesn't exist.
    19      * @throws NS_ERROR_NO_INTERFACE if the found property fails to QI to the 
    20      * given iid.
    21      */
    22     void get(in string prop, in nsIIDRef iid, 
    23              [iid_is(iid),retval] out nsQIResult result);
    25     /**
    26      * Sets a property with a given name to a given value. 
    27      */
    28     void set(in string prop, in nsISupports value);
    30     /**
    31      * Returns true if the property with the given name exists.
    32      */
    33     boolean has(in string prop);
    35     /**
    36      * Undefines a property.
    37      * @throws NS_ERROR_FAILURE if a property with that name doesn't
    38      * already exist.
    39      */
    40     void undefine(in string prop);
    42     /**
    43      *  Returns an array of the keys.
    44      */
    45     void getKeys(out uint32_t count, [array, size_is(count), retval] out string keys);
    46 };

mercurial