swi_system.h File Reference

This API provides operating system level facilities. More...

#include "returncodes.h"

Include dependency graph for swi_system.h:

Functions
rc_ReturnCode_t	swi_sys_Init ()
	Initializes the module.
rc_ReturnCode_t	swi_sys_Destroy ()
	Destroys the System library.
rc_ReturnCode_t	swi_sys_Reboot (const char *reasonPtr)
	Requests a reboot of the system, with an optional reason passed as a string, which will be logged.

---

Detailed Description

This API provides operating system level facilities.

---

---

Function Documentation

rc_ReturnCode_t swi_sys_Destroy

(

)

Destroys the System library.

Returns:

RC_OK on success

rc_ReturnCode_t swi_sys_Init

(

)

Initializes the module.

A call to init is mandatory to enable System library API.

Returns:

RC_OK on success

rc_ReturnCode_t swi_sys_Reboot

(

const char *

reasonPtr

)

Requests a reboot of the system, with an optional reason passed as a string, which will be logged.

Returns:

RC_OK on success

Parameters:

reasonPtr

[IN] the (logged) reason why the reboot is requested