qwf_InitializeCore()

Updated: April 19, 2023

Initialize the QWF core event-handling memory and queues

Synopsis:

#include <qwf/qwf_interface.h>
qwf_ReturnStatus_e qwf_InitializeCore(qwf_Context_t **ppCtx)

Arguments:

ppCtx
A pointer to memory for storing a pointer to the new QWF service context

Library:

qwf_interface

Description:

This function initializes the QWF core event-handling memory and queues (but no other QWF services), creates the QWF service context, and fills in a qwf_Context_t structure with the context's data. This function is useful when the client program wants to run a subset of the QWF services. In this case, the client must then use qwf_InitializeServices() to initialize specific services.

The function must return successfully before any service information can be read through the QWF API, because the context pointer provided by this function must be passed into all subsequent API calls.

Returns:

RETURN_STATUS_SUCCESS on success, RETURN_STATUS_FAILURE otherwise. Because this function is called only once, if it fails, it's due to an unrecoverable error (e.g., a serious memory issue) and the system needs a reboot.