24.05.2014 Views

Embedded Application Programming Interface - picmg

Embedded Application Programming Interface - picmg

Embedded Application Programming Interface - picmg

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

2.2 Keywords<br />

2.2.1 __IN<br />

In order to improve the readability this documents features keywords used before variables.<br />

Parameter Type<br />

Immediate value<br />

Pointer<br />

Characteristics<br />

Input value that must be specified and is essential<br />

Valid pointer to initialized buffer/variable.<br />

2.2.2 __OUT<br />

Parameter Type<br />

Pointer<br />

Characteristics<br />

Valid pointer to destination buffer/variable<br />

2.2.3 __INOPT<br />

Parameter Type<br />

Pointer<br />

Characteristics<br />

Valid pointer to initialized buffer/variable, or NULL Pointer.<br />

Note: refer to function specification for specifics.<br />

2.2.4 __OUTOPT<br />

Parameter Type<br />

Pointer<br />

Characteristics<br />

Valid pointer to destination buffer/variable, or NULL Pointer.<br />

Note: refer to function specification for specifics.<br />

2.2.5 __INOUT<br />

Parameter Type<br />

Pointer<br />

Characteristics<br />

Valid pointer to initialized buffer/variable. Contents of<br />

buffer/variable updated before return.<br />

2.3 Status Codes<br />

All EApi* functions immediately return a status code from a common list of possible errors.<br />

Any function may return any of the defined status codes.<br />

2.3.1 Status Code Description<br />

EAPI_STATUS_NOT_INITIALIZED<br />

Description<br />

The EAPI library is not yet or unsuccessfully initialized. EApiLibInitialize needs to be called prior to<br />

the first access of any other EAPI function.<br />

Actions<br />

Call EApiLibInitialize.<br />

PICMG® EAPI R1.0, August 8, 2010 page 16 of 83

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!