am_properties_create()

Creates an empty properties object.

Syntax

#include "am_properties.h"
AM_EXPORT am_status_t
am_properties_create(am_properties_t *properties_ptr);

Parameters

This function takes the following parameters:

properties_ptr

A pointer to where to store the handle of the new created properties object.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If a properties object was successfully created.

AM_NO_MEMORY

If unable to allocate memory for the properties object.

AM_INVALID_ARGUMENT

If the properties_ptr argument is NULL.

Details

Creates an instance of am_properties_t and assigns it to properties_ptr.

Memory Concerns: After the usage of the instance the caller must call am_properties_destroy to clean up the allocated memory.