le_apiFeatures.h File Reference

Go to the source code of this file.

Macros
#define	LE_FUNC_DISABLED(setting)
#define	LE_FULL_API   LE_FUNC_DISABLED("LINUX")
#define	LE_API_FILESYSTEM   LE_FUNC_DISABLED("FILESYSTEM")
	API requires filesystem support. More...

Detailed Description

API feature selection for Legato. This file provides a mapping of KConfig selections to API functions that are available. As an example, if file system support is disabled, then a compile-time error will be generated if an le_fs function is used.

Copyright (C) Sierra Wireless Inc.

Macro Definition Documentation

LE_FUNC_DISABLED

#define LE_FUNC_DISABLED

(

setting

)

Mark a function as disabled due to a KConfig selection.

Parameters

setting

Configuration setting name string.

LE_FULL_API

#define LE_FULL_API   LE_FUNC_DISABLED("LINUX")

Macro used to declare that a symbol is part of the "full" Legato API.

There are two APIs for Legato: "full" and "limited". Linux uses the "full" API and all functions are available. On other platforms only the "limited" API is supported, and any attempt to use a "full" api function will lead to a compile error.

LE_API_FILESYSTEM

#define LE_API_FILESYSTEM   LE_FUNC_DISABLED("FILESYSTEM")

API requires filesystem support.