am_properties_store()

Retrieves key/value information from the specified properties object and stores it in the specified file.

Syntax

#include "am_properties.h"
AM_EXPORT am_status_t
am_properties_store(am_properties_t properties, 
                    const char *file_name);

Parameters

This function takes the following parameters:

properties

The specified properties object.

file_name

Pointer to the file in which the property information will be stored.

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_NSPR_ERROR

If there is a problem writing to the file.

AM_INVALID_ARGUMENT

If properties or file_name is NULL or file_name points to an empty string.