swu_update_get_short_description()

Get the descriptive summary of a software update

Synopsis:

#include <swu/Update.h>
 
swu_result_t swu_update_get_short_description(
                                swu_update_t update, 
                                swu_string_t *description )

Arguments:

update: Handle of the Update.
description: Pointer to the string to store the short description.

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 descriptive summary of the software update referenced in update. This function retrieves the short description specified when the Update was created and stores it in description. Note that this description 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.