ACCESS Linux Platform SDK API Reference

The SDK API Reference is part of the ACCESS Linux Platform Software Development Kit. This reference complements the conceptual documentation included in the SDK by providing descriptions of all public function calls and important data structures. Together, the documents in the SDK explain how to use the APIs exposed to third-party developers to create applications for the ACCESS Linux Platform.

Note About APIs Supported By ACCESS

ACCESS supports only the APIs documented in this reference. ACCESS makes no commitment to support APIs that are not listed here.

Introduction to the APIs

This introduction provides an overview of what you will find, and discusses how you can navigate through the material. A note about open-source. Although several open-source components are used in application development for the ACCESS Linux Platform, the APIs for these components are not documented here. That documentation can be found in the open-source package itself.

Navigating the Reference

To begin, click on the plus sign (+) beside the Modules bookmark in the left pane. This will open a list of high-level categories that the technologies are grouped under. Under each category you will find sub-groupings that further refine the topic. As you navigate down through the module sub-groupings you will come to the page that lists and describes the APIs related to that technology.

You can also click on the Modules Tab or the Modules bookmark in the left pane to open the expanded list of groupings and sub-groupings.

To see a list of all functions, you can navigate in this (right-hand) pane to the Files > Globals > Functions tab.

Finding the Files

The header files where the structures and functions are defined can be found in different ways. Within Scratchbox, the header files can be found in the /targets/alp-simulator/usr/include/ folder. From outside of Scratchbox the header files can be found in the /scratchbox/users/$USER/targets/alp-simulator/usr/include/ folder. If your target is something other than alp-simulator, use that name instead. Within the include directory, the header files are either in the alp or the hiker directory. You can also view an uncommented version of the each header file by clicking on the Files Tab above and looking through the list.

ACCESS Linux Platform SDK API Reference

Note About APIs Supported By ACCESS

Introduction to the APIs

Navigating the Reference

Finding the Files

Other Documentation