DMS Get Stored Image Info response: libqmi-glib Reference Manual

DMS Get Stored Image Info response

DMS Get Stored Image Info response — Methods to manage the DMS Get Stored Image Info response.

Functions

QmiMessageDmsGetStoredImageInfoInput *	qmi_message_dms_get_stored_image_info_input_new ()
QmiMessageDmsGetStoredImageInfoInput *	qmi_message_dms_get_stored_image_info_input_ref ()
void	qmi_message_dms_get_stored_image_info_input_unref ()
gboolean	qmi_message_dms_get_stored_image_info_input_get_image_details ()
gboolean	qmi_message_dms_get_stored_image_info_input_set_image_details ()
QmiMessageDmsGetStoredImageInfoOutput *	qmi_message_dms_get_stored_image_info_output_ref ()
void	qmi_message_dms_get_stored_image_info_output_unref ()
gboolean	qmi_message_dms_get_stored_image_info_output_get_result ()
gboolean	qmi_message_dms_get_stored_image_info_output_get_boot_version ()
gboolean	qmi_message_dms_get_stored_image_info_output_get_pri_version ()
gboolean	qmi_message_dms_get_stored_image_info_output_get_oem_lock_id ()
QmiMessageDmsGetStoredImageInfoOutput *	qmi_message_dms_get_stored_image_info_response_parse ()
void	qmi_client_dms_get_stored_image_info ()
QmiMessageDmsGetStoredImageInfoOutput *	qmi_client_dms_get_stored_image_info_finish ()

Types and Values

	QmiMessageDmsGetStoredImageInfoInput
	QmiMessageDmsGetStoredImageInfoOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageDmsGetStoredImageInfoInput
    ╰── QmiMessageDmsGetStoredImageInfoOutput

Description

Collection of methods to create requests and parse responses of the DMS Get Stored Image Info message.

Functions

qmi_message_dms_get_stored_image_info_input_new ()

QmiMessageDmsGetStoredImageInfoInput *
qmi_message_dms_get_stored_image_info_input_new
                               (void);

Allocates a new QmiMessageDmsGetStoredImageInfoInput.

Returns

the newly created QmiMessageDmsGetStoredImageInfoInput. The returned value should be freed with qmi_message_dms_get_stored_image_info_input_unref().

Since: 1.0

qmi_message_dms_get_stored_image_info_input_ref ()

QmiMessageDmsGetStoredImageInfoInput *
qmi_message_dms_get_stored_image_info_input_ref
                               (QmiMessageDmsGetStoredImageInfoInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageDmsGetStoredImageInfoInput.

Returns

the new reference to self .

Since: 1.0

qmi_message_dms_get_stored_image_info_input_unref ()

void
qmi_message_dms_get_stored_image_info_input_unref
                               (QmiMessageDmsGetStoredImageInfoInput *self);

Atomically decrements the reference count of self by one. If the reference count drops to 0, self is completely disposed.

Parameters

self

a QmiMessageDmsGetStoredImageInfoInput.

Since: 1.0

qmi_message_dms_get_stored_image_info_input_get_image_details ()

gboolean
qmi_message_dms_get_stored_image_info_input_get_image_details
                               (QmiMessageDmsGetStoredImageInfoInput *self,
                                QmiDmsFirmwareImageType *value_image_details_type,
                                GArray **value_image_details_unique_id,
                                const gchar **value_image_details_build_id,
                                GError **error);

Get the 'Image Details' field from self .

Parameters

self	a QmiMessageDmsGetStoredImageInfoInput.
value_image_details_type	a placeholder for the output QmiDmsFirmwareImageType, or `NULL` if not required.	[out][optional]
value_image_details_unique_id	a placeholder for the output GArray of guint8 elements, or `NULL` if not required. Do not free it, it is owned by `self` .	[out][optional][element-type guint8][transfer none]
value_image_details_build_id	a placeholder for the output constant string, or `NULL` if not required.	[out][optional][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.32

qmi_message_dms_get_stored_image_info_input_set_image_details ()

gboolean
qmi_message_dms_get_stored_image_info_input_set_image_details
                               (QmiMessageDmsGetStoredImageInfoInput *self,
                                QmiDmsFirmwareImageType value_image_details_type,
                                GArray *value_image_details_unique_id,
                                const gchar *value_image_details_build_id,
                                GError **error);

Set the 'Image Details' field in the message.

Parameters

self	a QmiMessageDmsGetStoredImageInfoInput.
value_image_details_type	a QmiDmsFirmwareImageType.
value_image_details_unique_id	a GArray of guint8 elements. A new reference to `value_image_details_unique_id` will be taken, so the caller must make sure the array was created with the correct GDestroyNotify as clear function for each element in the array.	[in][element-type guint8][transfer none]
value_image_details_build_id	a constant string.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.32

qmi_message_dms_get_stored_image_info_output_ref ()

QmiMessageDmsGetStoredImageInfoOutput *
qmi_message_dms_get_stored_image_info_output_ref
                               (QmiMessageDmsGetStoredImageInfoOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageDmsGetStoredImageInfoOutput.

Returns

the new reference to self .

Since: 1.0

qmi_message_dms_get_stored_image_info_output_unref ()

void
qmi_message_dms_get_stored_image_info_output_unref
                               (QmiMessageDmsGetStoredImageInfoOutput *self);

Atomically decrements the reference count of self by one. If the reference count drops to 0, self is completely disposed.

Parameters

self

a QmiMessageDmsGetStoredImageInfoOutput.

Since: 1.0

qmi_message_dms_get_stored_image_info_output_get_result ()

gboolean
qmi_message_dms_get_stored_image_info_output_get_result
                               (QmiMessageDmsGetStoredImageInfoOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

self	a QmiMessageDmsGetStoredImageInfoOutput.
error	Return location for error or `NULL`.

Returns

TRUE if the QMI operation succeeded, FALSE if error is set.

[skip]

Since: 1.0

qmi_message_dms_get_stored_image_info_output_get_boot_version ()

gboolean
qmi_message_dms_get_stored_image_info_output_get_boot_version
                               (QmiMessageDmsGetStoredImageInfoOutput *self,
                                guint16 *value_boot_version_major_version,
                                guint16 *value_boot_version_minor_version,
                                GError **error);

Get the 'Boot Version' field from self .

Parameters

self	a QmiMessageDmsGetStoredImageInfoOutput.
value_boot_version_major_version	a placeholder for the output guint16, or `NULL` if not required.	[out][optional]
value_boot_version_minor_version	a placeholder for the output guint16, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.0

qmi_message_dms_get_stored_image_info_output_get_pri_version ()

gboolean
qmi_message_dms_get_stored_image_info_output_get_pri_version
                               (QmiMessageDmsGetStoredImageInfoOutput *self,
                                guint32 *value_pri_version_pri_version,
                                const gchar **value_pri_version_pri_info,
                                GError **error);

Get the 'PRI Version' field from self .

Parameters

self	a QmiMessageDmsGetStoredImageInfoOutput.
value_pri_version_pri_version	a placeholder for the output guint32, or `NULL` if not required.	[out][optional]
value_pri_version_pri_info	a placeholder for the output constant string, or `NULL` if not required.	[out][optional][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.0

qmi_message_dms_get_stored_image_info_output_get_oem_lock_id ()

gboolean
qmi_message_dms_get_stored_image_info_output_get_oem_lock_id
                               (QmiMessageDmsGetStoredImageInfoOutput *self,
                                guint32 *value_oem_lock_id,
                                GError **error);

Get the 'OEM Lock ID' field from self .

Parameters

self	a QmiMessageDmsGetStoredImageInfoOutput.
value_oem_lock_id	a placeholder for the output guint32, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.0

qmi_message_dms_get_stored_image_info_response_parse ()

QmiMessageDmsGetStoredImageInfoOutput *
qmi_message_dms_get_stored_image_info_response_parse
                               (QmiMessage *message,
                                GError **error);

Parses a QmiMessage and builds a QmiMessageDmsGetStoredImageInfoOutput out of it. The operation fails if the message is of the wrong type.

Parameters

message	a QmiMessage.
error	return location for error or `NULL`.

Returns

a QmiMessageDmsGetStoredImageInfoOutput, or NULL if error is set. The returned value should be freed with qmi_message_dms_get_stored_image_info_output_unref().

Since: 1.34

qmi_client_dms_get_stored_image_info ()

void
qmi_client_dms_get_stored_image_info (QmiClientDms *self,
                                      QmiMessageDmsGetStoredImageInfoInput *input,
                                      guint timeout,
                                      GCancellable *cancellable,
                                      GAsyncReadyCallback callback,
                                      gpointer user_data);

Asynchronously sends a Get Stored Image Info request to the device.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.

You can then call qmi_client_dms_get_stored_image_info_finish() to get the result of the operation.

Parameters

self	a QmiClientDms.
input	a QmiMessageDmsGetStoredImageInfoInput.
timeout	maximum time to wait for the method to complete, in seconds.
cancellable	a GCancellable or `NULL`.
callback	a GAsyncReadyCallback to call when the request is satisfied.
user_data	user data to pass to `callback` .

Since: 1.0

qmi_client_dms_get_stored_image_info_finish ()

QmiMessageDmsGetStoredImageInfoOutput *
qmi_client_dms_get_stored_image_info_finish
                               (QmiClientDms *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_dms_get_stored_image_info().

Parameters

self	a QmiClientDms.
res	the GAsyncResult obtained from the GAsyncReadyCallback passed to `qmi_client_dms_get_stored_image_info()`.
error	Return location for error or `NULL`.

Returns

a QmiMessageDmsGetStoredImageInfoOutput, or NULL if error is set. The returned value should be freed with qmi_message_dms_get_stored_image_info_output_unref().

Since: 1.0

Types and Values

QmiMessageDmsGetStoredImageInfoInput

typedef struct _QmiMessageDmsGetStoredImageInfoInput QmiMessageDmsGetStoredImageInfoInput;

The QmiMessageDmsGetStoredImageInfoInput structure contains private data and should only be accessed using the provided API.

Since: 1.0

QmiMessageDmsGetStoredImageInfoOutput

typedef struct _QmiMessageDmsGetStoredImageInfoOutput QmiMessageDmsGetStoredImageInfoOutput;

The QmiMessageDmsGetStoredImageInfoOutput structure contains private data and should only be accessed using the provided API.

Since: 1.0