Ice 3.7 Slice API Reference
PropertiesAdmin.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICE_API"]]
8 [["cpp:doxygen:include:Ice/Ice.h"]]
9 [["cpp:header-ext:h"]]
10 
11 [["ice-prefix"]]
12 
13 [["js:module:ice"]]
14 [["js:cjs-module"]]
15 
16 [["objc:dll-export:ICE_API"]]
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:Ice"]]
20 
21 #include <Ice/BuiltinSequences.ice>
22 
23 #ifndef __SLICE2JAVA_COMPAT__
24 [["java:package:com.zeroc"]]
25 #endif
26 
27 ["objc:prefix:ICE"]
28 module Ice
29 {
30 
39 dictionary<string, string> PropertyDict;
40 
47 interface PropertiesAdmin
48 {
59  string getProperty(string key);
60 
70  ["java:type:java.util.TreeMap<String, String>"] PropertyDict getPropertiesForPrefix(string prefix);
71 
84  void setProperties(PropertyDict newProperties);
85 }
86 
87 }
Ice::PropertyDict
dictionary< string, string > PropertyDict
A simple collection of properties, represented as a dictionary of key/value pairs.
Definition: PropertiesAdmin.ice:39
BuiltinSequences.ice
Ice::PropertiesAdmin::getProperty
string getProperty(string key)
Get a property by key.
Ice
The Ice core library.
Definition: BuiltinSequences.ice:27
Ice::PropertiesAdmin::getPropertiesForPrefix
PropertyDict getPropertiesForPrefix(string prefix)
Get all properties whose keys begin with prefix.
Ice::PropertiesAdmin
The PropertiesAdmin interface provides remote access to the properties of a communicator.
Definition: PropertiesAdmin.ice:48
Ice::PropertiesAdmin::setProperties
void setProperties(PropertyDict newProperties)
Update the communicator's properties with the given property set.