swu_target_unregister()

Inform the UpdateClient that an UpdateTarget is no longer available

Synopsis:

#include <swu/UpdateTargetInterface.h>
 
swu_result_t swu_target_unregister( swu_target_id_t id )

Arguments:

id
ID of the UpdateTarget to unregister. This ID was assigned by the library in the call to swu_target_register().

Library:

libswu-core

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

Description:

Inform the UpdateClient that an UpdateTarget is no longer available. This function removes the UpdateTarget specified in id from the library. After this function is called, the UpdateClient won't call the functions referenced by the pointers in the target's associated swu_target_interface_t structure. At this point, this interface structure is no longer needed.

The ID assigned to the unregistered UpdateTarget won't be used again during the same power cycle.

Returns:

One of the following swu_result_t values:

SWU_RESULT_SUCCESS
The operation succeeded.
SWU_RESULT_NOT_FOUND
An UpdateTarget with the specified ID could not be found.
SWU_RESULT_INVALID_ARGUMENT
An invalid argument was given.
SWU_RESULT_ERROR
Another error occurred.