Public Member Functions
ScPropertyCollection Struct Reference

Public Member Functions

ScBool sc_property_collection_is_property_known (ScPropertyCollection const *properties, char const *key)
 
ScBool sc_property_collection_get_property_value (ScPropertyCollection const *properties, char const *key, ScPropertyValue *out_value)
 
ScBool sc_property_collection_set_property_value (ScPropertyCollection *properties, char const *key, ScPropertyValue value)
 
ScBool sc_property_collection_get_bool_property (ScPropertyCollection const *properties, char const *key, ScBool *out_value)
 
ScBool sc_property_collection_get_int_property (ScPropertyCollection const *properties, char const *key, int *out_value)
 
ScBool sc_property_collection_get_float_property (ScPropertyCollection const *properties, char const *key, float *out_value)
 
ScBool sc_property_collection_get_string_property (ScPropertyCollection const *properties, char const *key, char const **out_value)
 
ScBool sc_property_collection_set_bool_property (ScPropertyCollection *properties, char const *key, ScBool value)
 
ScBool sc_property_collection_set_int_property (ScPropertyCollection *properties, char const *key, int value)
 
ScBool sc_property_collection_set_float_property (ScPropertyCollection *properties, char const *key, float value)
 
ScBool sc_property_collection_set_string_property (ScPropertyCollection *properties, char const *key, char const *value)
 

Detailed Description

Handle to a collection of properties.

Since
7.0.0

Member Function Documentation

ScBool sc_property_collection_is_property_known ( ScPropertyCollection const *  properties,
char const *  key 
)

Return whether a property with a given name is known to the collection.

Parameters
propertiesThe settings accessor object. Must not be null.
keyThe name of the property.
Returns
SC_TRUE when the property is known to the collection, SC_FALSE - otherwise.
Since
7.0.0
ScBool sc_property_collection_get_property_value ( ScPropertyCollection const *  properties,
char const *  key,
ScPropertyValue *  out_value 
)

Retrieves set property value by name.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
out_valuePointer to a property value to be set. Must not be null.
Returns
SC_TRUE when the property collection has value for the property, SC_FALSE - otherwise.
Since
7.0.0
ScBool sc_property_collection_set_property_value ( ScPropertyCollection *  properties,
char const *  key,
ScPropertyValue  value 
)

Set custom property value.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
valueThe value to be set.
Returns
SC_TRUE - if property has been successfully updated with the provided value, SC_FALSE if input validation failed (property does not exist or has different type or value is invalid).
Since
7.0.0
ScBool sc_property_collection_get_bool_property ( ScPropertyCollection const *  properties,
char const *  key,
ScBool *  out_value 
)

Retrieves a bool property from the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
out_valuePointer to a valid property value to be set. Must not be null.
Returns
SC_TRUE - if property value has been successfully retrieved, SC_FALSE if input validation failed (property does not exist or has different type or does not have value set).
Since
7.0.0
ScBool sc_property_collection_get_int_property ( ScPropertyCollection const *  properties,
char const *  key,
int *  out_value 
)

Retrieves an int property from the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
out_valuePointer to a valid property value to be set. Must not be null.
Returns
SC_TRUE - if property value has been successfully retrieved, SC_FALSE if input validation failed (property does not exist or has different type or does not have value set).
Since
7.0.0
ScBool sc_property_collection_get_float_property ( ScPropertyCollection const *  properties,
char const *  key,
float *  out_value 
)

Retrieves a float property from the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
out_valuePointer to a valid property value to be set. Must not be null.
Returns
SC_TRUE - if property value has been successfully retrieved, SC_FALSE if input validation failed (property does not exist or has different type or does not have value set).
Since
7.0.0
ScBool sc_property_collection_get_string_property ( ScPropertyCollection const *  properties,
char const *  key,
char const **  out_value 
)

Retrieves a bool property from the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
out_valuePointer to a C string pointer to be set. Must not be null. Underlying string memory buffer is owned by the property collection.
Returns
SC_TRUE - if property value has been successfully retrieved, SC_FALSE if input validation failed (property does not exist or has different type or does not have value set).
Since
7.0.0
ScBool sc_property_collection_set_bool_property ( ScPropertyCollection *  properties,
char const *  key,
ScBool  value 
)

Set a bool property to the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
valueThe value to be set.
Returns
SC_TRUE - if property has been successfully updated with the provided value, SC_FALSE if input validation failed (property does not exist or has different type).
Since
7.0.0
ScBool sc_property_collection_set_int_property ( ScPropertyCollection *  properties,
char const *  key,
int  value 
)

Set an int property to the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
valueThe value to be set.
Returns
SC_TRUE - if property has been successfully updated with the provided value, SC_FALSE if input validation failed (property does not exist or has different type).
Since
7.0.0
ScBool sc_property_collection_set_float_property ( ScPropertyCollection *  properties,
char const *  key,
float  value 
)

Set a float property to the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
valueThe value to be set.
Returns
SC_TRUE - if property has been successfully updated with the provided value, SC_FALSE if input validation failed (property does not exist or has different type).
Since
7.0.0
ScBool sc_property_collection_set_string_property ( ScPropertyCollection *  properties,
char const *  key,
char const *  value 
)

Set a string property to the given property collection.

Parameters
propertiesThe property collection handle. Must not be null.
keyThe name of the property.
valueThe null-terminated C string pointer value to be set. Must not be null.
Returns
SC_TRUE - if property has been successfully updated with the provided value, SC_FALSE if input validation failed (property does not exist or has different type).
Since
7.0.0
The documentation for this struct was generated from the following file:
Copyright (C) 2025 Scandit AG