Initialization, Keapilibinitialize, Keapilibuninitialize – Kontron KEAPI User Manual

Page 7: General information, Keapigetboardinfo, 2 initialization, 3 general information, 1 keapilibinitialize, 2 keapilibuninitialize, 1 keapigetboardinfo

Advertising
background image

Software specification for Kontron EAPI

7

2.2 Initialization

2.2.1 KEApiLibInitialize

KEAPI_CALLTYPE

KEAPI_UINT32

KEApiLibInitialize (

KEAPI_PCHAR

pHostIp,

KEAPI_UINT32

port,

KEAPI_PUINT32

pBoardHandle,

KEAPI_UINT32

logLevel,

KEAPI_PCHAR

pLogFile

);

Description:

Initialization of Kontron EAPI.

Parameters:

in/out

Parameter name

Description

in

pHostIp

IP address of a remote computer. If it is set to NULL or
“localhost” then localhost is considered to be the target
machine (no KEAPI server running on the machine is
needed). If it is set to

“127.0.0.1”, then it connects to KEAPI

server running on the local machine (can be used for testing
KEAPI server application locally)

in

port

Port number where KEAPI server is listening, default is 7890.

out

pBoardHandle

Returned pointer to the handle of selected board.
BoardHandle == 0 means localhost.

In

logLevel

Level of details

LV_ERROR = 0x01,

LV_WARN = 0x02,

LV_INFO = 0x04,

LV_DEBUG = 0x08,

LV_TRACE = 0x10,

LV_ALLTIME = 0xFF

in

pLogFile

Name of the log file. Can be NULL if logging not needed.

2.2.2 KEApiLibUnInitialize

KEAPI_CALLTYPE

KEAPI_UINT32

KEApiLibUnInitialize (

KEAPI_UINT32

boardHandle

);

Description:

Uninitialization of Kontron EAPI on a selected board.

Parameters:

in/out

Parameter name

Description

in

boardHandle

Handle of the selected board

2.3 General information

2.3.1 KEApiGetBoardInfo

KEAPI_CALLTYPE

KEAPI_UINT32

KEApiGetBoardInfo (

KEAPI_UINT32

boardHandle,

PBOARD_INFO

pBoardInfo

);

Advertising