comparison: src/ucx/properties.h
src/ucx/properties.h
- changeset 278
- 7b9170c22786
- parent 259
- 2f5dea574a75
equal
deleted
inserted
replaced
| 277:f819fe5e20f5 | 278:7b9170c22786 |
|---|---|
| 171 | 171 |
| 172 /** | 172 /** |
| 173 * Retrieves all available key/value-pairs and puts them into a UcxMap. | 173 * Retrieves all available key/value-pairs and puts them into a UcxMap. |
| 174 * | 174 * |
| 175 * This is done by successive calls to ucx_properties_next() until no more | 175 * This is done by successive calls to ucx_properties_next() until no more |
| 176 * key/value-pairs can be retrieved. | 176 * key/value-pairs can be retrieved. |
| 177 * | |
| 178 * The memory for the map values is allocated by the map's own allocator. | |
| 177 * | 179 * |
| 178 * @param prop the UcxProperties object | 180 * @param prop the UcxProperties object |
| 179 * @param map the target map | 181 * @param map the target map |
| 180 * @return The UcxProperties.error code (i.e. 0 on success). | 182 * @return The UcxProperties.error code (i.e. 0 on success). |
| 181 * @see ucx_properties_fill() | 183 * @see ucx_properties_fill() |
| 184 * @see UcxMap.allocator | |
| 182 */ | 185 */ |
| 183 int ucx_properties2map(UcxProperties *prop, UcxMap *map); | 186 int ucx_properties2map(UcxProperties *prop, UcxMap *map); |
| 184 | 187 |
| 185 /** | 188 /** |
| 186 * Loads a properties file to a UcxMap. | 189 * Loads a properties file to a UcxMap. |
