sternum_settings.h File Reference

Provides definition of sternum_sdk_settings_t structure. More...

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "sternum_sdk/api/sternum_error_codes.h"

Go to the source code of this file.

Data structures
struct	sternum_sdk_settings_t
	Configuration structure for initializing the SDK. More...

Functions
void	init_sternum_sdk_settings (sternum_sdk_settings_t *settings)
	Default-initialize settings structure for the SDK. More...

Typedefs
typedef struct sternum_sdk_settings_t	sternum_sdk_settings_t

Detailed Description

Provides definition of sternum_sdk_settings_t structure.

Function Documentation

init_sternum_sdk_settings()

void init_sternum_sdk_settings

(

sternum_sdk_settings_t *

settings

)

Default-initialize settings structure for the SDK.

Use this function to initialize a sternum_sdk_settings_t with default values. Using this function is crucial to prevent uninitialized or garbage data in linked pointers, ensuring the structure begins in a clean state. This minimizes the risk of errors due to unpredictable or undefined values.

Example: sternum_sdk_settings_t g_sternum_settings; init_sternum_sdk_settings(&g_sternum_settings);

Typedef Documentation

sternum_sdk_settings_t

typedef struct sternum_sdk_settings_t sternum_sdk_settings_t