am_properties_set()

Sets a value for the specified key in the specified properties object.

Details

The specified value will replace any existing value.

Syntax

#include "am_properties.h"
AM_EXPORT am_status_t
am_properties_set(am_properties_t properties, 
                  const char *key,
                  const char *value);

Parameters

This function takes the following parameters:

properties

The specified properties object.

key

Pointer to the key being modified.

value

Pointer to the value to associate with the specified key.

Returns

This function returns one of the following values of the am_status_t enumeration (defined in the <am_types.h> header file):

AM_SUCCESS

If no error is detected.

AM_INVALID_ARGUMENT

If the properties, key, or value argument is NULL.

AM_NO_MEMORY

If unable to allocate memory to store the new key/value.