Aim MIL-STD-1553 - Apigeterrordescription

28 MIL-STD-1553 Reference Manual
Chapter 2 - Library Administration and Initialization Functions
2.1.9 ApiGetErrorDescription
Prototype:
const char * ApiGetErrorDescription( AiIn16 wErrorCode );
Driver Command:
(none)
Purpose:
Returns a string with a description for the error code passed as input. This function
might be called with a return value from any API function.
All API calls return API_OK in a no error condition. The return value of each API call
should be checked if it is not equal to API_OK.
Input
A
A
i
i
I
I
n
n
t
t
1
1
6
6
w
w
E
E
r
r
r
r
o
o
r
r
C
C
o
o
d
d
e
e
The error code to be described.
Output
n
n
o
o
n
n
e
e
Return Value
c
c
o
o
n
n
s
s
t
t
c
c
h
h
a
a
r
r
*
*
A pointer to a string with the error description.