Ice Reference Documentation | ||
---|---|---|
<<< Previous | Slice Documentation | Next >>> |
local interface |
A property set used to configure Ice and Ice applications. Properties are key/value pairs, with both keys and values being strings. By convention, property keys should have the form application-name[.category[.sub-category]].name.
Get a property by key.
Get a property by key.
Get a property as an integer.
Get a property as an integer.
Get all properties whose keys begins with prefix.
Set a property.
Get a sequence of command-line options that is equivalent to this property set.
Convert a sequence of command-line options into properties.
Convert a sequence of command-line options into properties.
Load properties from a file.
Create a copy of this property set.
string getProperty(string key); |
Get a property by key. If the property does not exist, an empty string is returned.
The property key.
The property value.
string getPropertyWithDefault(string key, string value); |
Get a property by key. If the property does not exist, the given default value is returned.
The property key.
The default value to use if the property does not exist.
The property value or the default value.
int getPropertyAsInt(string key); |
Get a property as an integer. If the property does not exist, 0 is returned.
The property key.
The property value interpreted as an integer.
int getPropertyAsIntWithDefault(string key, int value); |
Get a property as an integer. If the property does not exist, the given default value is returned.
The property key.
The default value to use if the property does not exist.
The property value interpreted as an integer, or the default value.
PropertyDict getPropertiesForPrefix(string prefix); |
Get all properties whose keys begins with prefix. If prefix is an empty string, then all properties are returned.
The matching property set.
void setProperty(string key, string value); |
Set a property. To unset a property, set it to the empty string.
The property key.
The property value.
StringSeq getCommandLineOptions(); |
Get a sequence of command-line options that is equivalent to this property set. Each element of the returned sequence is a command-line option of the form --key=value.
The command line options for this property set.
StringSeq parseCommandLineOptions(string prefix, StringSeq options); |
Convert a sequence of command-line options into properties. All options that begin with --prefix. are converted into properties. If the prefix is empty, all options that begin with -- are converted to properties.
The property prefix, or an empty string to convert all options starting with --.
The command-line options.
The command-line options that do not start with the specified prefix, in their original order.
StringSeq parseIceCommandLineOptions(StringSeq options); |
Convert a sequence of command-line options into properties. All options that begin with one of the following prefixes are converted into properties: --Ice, --IceBox, --IceGrid, --IcePatch, --IcePatch2, --IceSSL, --IceStorm, --Freeze, --Glacier, and --Glacier2.
The command-line options.
The command-line options that do not start with one of the listed prefixes, in their original order.
|
Create a copy of this property set.
A copy of this property set.
<<< Previous | Home | Next >>> |
Ice::Process | Up | Ice::ProtocolException |