Reference Manual > DSL_userProperties

Header file: general.h

DSL_userProperties objects are key-value maps. Both key and value are strings. Keys must be unique and valid SMILE identifiers.

int GetNumberOfProperties() const;

Returns the number of stored properties.

const char* GetPropertyName(int index) const;

Returns the name (key) of the property.

const char* GetPropertyValue(int index) const;

Returns the value of the property.

int FindProperty(const char* name) const;

Returns the index of the property with a specified name, or a negative value if the property was not found.

int AddProperty(const char* name, const char* value);

Adds a property. Returns DSL_OKAY on success, or a negative error code on failure.

int InsertProperty(int index, const char* name, const char* value);

Inserts a property at the specified index. Returns DSL_OKAY on success, or a negative error code on failure.

int ChangePropertyName(int index, const char* name);

Modifies the property name at the specified index. Returns DSL_OKAY on success, or a negative error code on failure.

int ChangePropertyValue(int index, const char* value);

Modifies the property name at the specified index. Returns DSL_OKAY on success, or a negative error code on failure.

int DeleteProperty(int index);

Deletes the property at the specified index. Returns DSL_OKAY on success, or a negative error code on failure.

void Clear();

Removes all properties.