am_properties_destroy()

Destroys the properties object referenced by the provided handle.

Syntax

#include "am_properties.h"
AM_EXPORT void
 am_properties_destroy(am_properties_t properties);

Parameters

This function takes the following parameters:

properties

The handle for the properties object to be destroyed.

Returns

This function returns one of the following values:

AM_SUCCESS

If the operation was successful.

AM_INVALID_ARGUMENT

If properties argument is NULL.

Details

Destroys an instance of am_properties_t.

Memory Concerns: Caller must make sure not to pass the same instance of am_properties_t to be destroyed more than once. After calling this function it is advised that the caller initializes properties to NULL.