---
title: "The Properties Class"
url: https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class
language: cpp
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# The Properties Class

Programming language: C++. Other languages: [C#](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/csharp.md), [Java](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/java.md), [JavaScript](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/php.md), [Python](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/python.md), [Ruby](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/ruby.md), [Swift](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-class/swift.md).

A [Properties](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties.html) object, or *property set*, is a collection of properties. Each communicator has a property set, which its [`getProperties`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Communicator_aeb1e43dec06e3e2698e12b8266c1f18d.html#aeb1e43dec06e3e2698e12b8266c1f18d) method returns. You can also create a property set yourself, for example to configure a new communicator.

## Reading and Setting a Property

[`getProperty`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a4f3232722e42f1ca3b5018ccc70ae7e9.html#a4f3232722e42f1ca3b5018ccc70ae7e9), [`getPropertyAsInt`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_acb291d6c408c8c1299fcf9dcf147c4c1.html#acb291d6c408c8c1299fcf9dcf147c4c1), and [`getPropertyAsList`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a7cc9e3937856655d9fb91adafacbbfa9.html#a7cc9e3937856655d9fb91adafacbbfa9) read a property as a string, an integer, or a list of strings. Their `WithDefault` variants, [`getPropertyWithDefault`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a13ab56dbfe617028524a773f8a2286b5.html#a13ab56dbfe617028524a773f8a2286b5), [`getPropertyAsIntWithDefault`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a738eaba9a7275739b5eda0b0f7824684.html#a738eaba9a7275739b5eda0b0f7824684), and [`getPropertyAsListWithDefault`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a42dc1c1ba4186a0d1b0f09e7dfc50ee8.html#a42dc1c1ba4186a0d1b0f09e7dfc50ee8), return the default you give for a property that is not set.

[`setProperty`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a7175c5e5066e5a8a744cd3572018d40c.html#a7175c5e5066e5a8a744cd3572018d40c) sets a property, and applies the [property validation](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-overview/cpp.md#property-validation) rules.

## Reading an Ice Property

An *Ice property* is a property that Ice defines, such as `Ice.Warn.Dispatch`: its name begins with a [reserved prefix](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-overview/cpp.md#reserved-prefixes), and the [property reference](https://docs.zeroc.com/ice/3.8/property-reference.md) lists it with its default value. [`getIceProperty`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a7d3ee16e5b1edf0ab060c0b748dcf8f5.html#a7d3ee16e5b1edf0ab060c0b748dcf8f5), [`getIcePropertyAsInt`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a89df5433506160c5b95b644404a2dce2.html#a89df5433506160c5b95b644404a2dce2), and [`getIcePropertyAsList`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_abb9e28fa93514d0d28c3df788ca01356.html#abb9e28fa93514d0d28c3df788ca01356) read an Ice property and, unlike the plain `getProperty` methods, return its default value when it is not set. For example, if you never set `Ice.Warn.Dispatch`, `getIcePropertyAsInt("Ice.Warn.Dispatch")` returns its default of `1`, while `getPropertyAsInt("Ice.Warn.Dispatch")` returns `0`.

These three methods accept only the names of Ice properties. Read the other properties, such as the properties of an object adapter or a proxy, with the plain `getProperty` methods, which take any name.

## Reading and Parsing Groups of Properties

[`getPropertiesForPrefix`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a79214da2a157ee75f40e269a92c292bf.html#a79214da2a157ee75f40e269a92c292bf) returns the properties whose names begin with a prefix, and marks them as [used](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-overview/cpp.md#unused-properties). [`parseCommandLineOptions`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_aa3157c9cfd9480d9e653df01442f706c.html#aa3157c9cfd9480d9e653df01442f706c) and [`parseIceCommandLineOptions`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_a1c21945b428f0afff7850409ee54ac8c.html#a1c21945b428f0afff7850409ee54ac8c) convert command-line arguments of the form `--name=value` into properties, with the same validation as `setProperty`, and [`getCommandLineOptions`](https://code.zeroc.com/ice/3.8/api/cpp/classIce_1_1Properties_ab46acdf866a117aca7fa4c11bfeede5a.html#ab46acdf866a117aca7fa4c11bfeede5a) converts a property set back into such arguments.
