swu_target_get

Synopsis:

#include <swu/UpdateTarget.h>
 
swu_result_t swu_target_get_info( 
                        swu_target_t target, 
                        swu_target_sw_information_t *info )

Arguments:

target: Handle of an UpdateTarget whose information is requested by the caller.
info: Pointer to an swu_target_sw_information_t structure that will store the target information.

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 information about the UpdateTarget referred to by target. This function copies the target's information into the structure whose address is given in info. The information includes the ID values of the target, the version of the software installed on it, and more.

When swu_target_get_info() is called, the library calls the function referenced in the get_info field of the swu_target_interface_t structure associated with the UpdateTarget and then passes this function's return value back to the caller.

Returns:

One of the following swu_result_t values:

SWU_RESULT_INVALID_ARGUMENT: The target ID was invalid.
Return code from get_info function: When a valid ID is given, the function returns the result code it receives from the get_info function supplied by the UpdateTarget.