swu_update_get_prompt_to_install()

Get flag indicating whether the user should be prompted to install an update

Synopsis:

#include <swu/Update.h>
 
swu_result_t swu_update_get_prompt_to_install( 
                                swu_update_t update, 
                                bool *prompt )

Arguments:

update
Handle of the Update.
prompt
Pointer to Boolean to store whether the user should be prompted for this update.

Library:

libswu-core

Use the -l swu-core option with qcc to link against the SWU library. This library is usually included automatically.

Description:

Get the flag indicating whether the HMI should prompt the user to accept the installation of the software update referenced in update. This function stores the flag setting in prompt. This flag was set when the Update object was created and can't be changed afterwards.

Returns:

One of the following swu_result_t values:

SWU_RESULT_SUCCESS
The operation succeeded.
SWU_RESULT_INVALID_ARGUMENT
One of the arguments is invalid.