Embedded Application Programming Interface - picmg

3 Initialization Functions
3.1 EApiLibInitialize
uint32_t
EAPI_CALLTYPE
EApiLibInitialize(void);
FUNC_DEF 1: EApiLibInitialize
3.1.1 Description:
General initialization of the EAPI. Prior to calling any EAPI function the library needs to be initialized by
calling this function. The status code for all EAPI function will be EAPI_STATUS_NOT_INITIALIZED
unless this function is called.
3.1.2 Parameters
None.
3.1.3 Return Status Code
Condition
Library initialized
Return Value
EAPI_STATUS_INITIALIZED
... see 2.3 Status Codes on page 16
Success
EAPI_STATUS_SUCCESS
3.2 EApiLibUnInitialize
3.2.1 Description:
General function to uninitialized the EAPI library. Should be called before program exit.
In a dynamic library environment this function is not expected to replace the native uninitialize
routines. It Is expected that in this environments this function has no functionality.
3.2.2 Parameters
None.
uint32_t
EAPI_CALLTYPE
EApiLibUnInitialize(void);
FUNC_DEF 2: EApiLibUnInitialize
3.2.3 Return Status Code
Condition
Library Uninitialized
Return Value
EAPI_STATUS_NOT_INITIALIZED
... see 2.3 Status Codes on page 16
Success
EAPI_STATUS_SUCCESS
PICMG® EAPI R1.0, August 8, 2010 page 20 of 83