swu_update_get_defer_period()

Get the maximum deferral period for accepting a software update

Synopsis:

#include <swu/Update.h>
 
swu_result_t swu_update_get_defer_period( 
                                swu_update_t update, 
                                swu_timestamp_t *period )

Arguments:

update
Handle of the Update.
period
Pointer to the swu_timestamp_t to store the deferral period.

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 maximum deferral period for accepting the software update specified in update. This function retrieves the deferral period specified when the Update was created and stores it in period. Note that the deferral period can't be changed after the Update has been created.

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.