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