am_properties_load()

Loads property information from the specified file.

Syntax

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

Parameters

This function takes the following parameters:

properties

Handle to the properties object to be modified.

file_name

Name of the file from which to load the property information.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If no error is detected.

AM_NOT_FOUND

If the specified file does not exist.

AM_NSPR_ERROR

If there is a problem accessing the file.

AM_INVALID_ARGUMENT

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

AM_NO_MEMORY

If unable to allocate memory to store the property information.

Details

The file is expected to use the standard Java Properties file syntax.