DMS Get Firmware Preference response: libqmi-glib Reference Manual

DMS Get Firmware Preference response

DMS Get Firmware Preference response — Methods to manage the DMS Get Firmware Preference response.

Functions

QmiMessageDmsGetFirmwarePreferenceOutput *	qmi_message_dms_get_firmware_preference_output_ref ()
void	qmi_message_dms_get_firmware_preference_output_unref ()
gboolean	qmi_message_dms_get_firmware_preference_output_get_result ()
gboolean	qmi_message_dms_get_firmware_preference_output_get_list ()
gboolean	qmi_message_dms_get_firmware_preference_output_get_list_gir ()
QmiMessageDmsGetFirmwarePreferenceOutput *	qmi_message_dms_get_firmware_preference_response_parse ()
void	qmi_client_dms_get_firmware_preference ()
QmiMessageDmsGetFirmwarePreferenceOutput *	qmi_client_dms_get_firmware_preference_finish ()

Types and Values

	QmiMessageDmsGetFirmwarePreferenceOutput
	QmiMessageDmsGetFirmwarePreferenceOutputListImage

Object Hierarchy

    GBoxed
    ├── QmiMessageDmsGetFirmwarePreferenceOutput
    ╰── QmiMessageDmsGetFirmwarePreferenceOutputListImage

Description

Collection of methods to create requests and parse responses of the DMS Get Firmware Preference message.

Functions

qmi_message_dms_get_firmware_preference_output_ref ()

QmiMessageDmsGetFirmwarePreferenceOutput *
qmi_message_dms_get_firmware_preference_output_ref
                               (QmiMessageDmsGetFirmwarePreferenceOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageDmsGetFirmwarePreferenceOutput.

Returns

the new reference to self .

Since: 1.0

qmi_message_dms_get_firmware_preference_output_unref ()

void
qmi_message_dms_get_firmware_preference_output_unref
                               (QmiMessageDmsGetFirmwarePreferenceOutput *self);

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

Parameters

self

a QmiMessageDmsGetFirmwarePreferenceOutput.

Since: 1.0

qmi_message_dms_get_firmware_preference_output_get_result ()

gboolean
qmi_message_dms_get_firmware_preference_output_get_result
                               (QmiMessageDmsGetFirmwarePreferenceOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

self	a QmiMessageDmsGetFirmwarePreferenceOutput.
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_firmware_preference_output_get_list ()

gboolean
qmi_message_dms_get_firmware_preference_output_get_list
                               (QmiMessageDmsGetFirmwarePreferenceOutput *self,
                                GArray **value_list,
                                GError **error);

Get the 'List' field from self .

[skip]

Parameters

self	a QmiMessageDmsGetFirmwarePreferenceOutput.
value_list	a placeholder for the output GArray of QmiMessageDmsGetFirmwarePreferenceOutputListImage elements, or `NULL` if not required. Do not free it, it is owned by `self` .	[out][optional][element-type QmiMessageDmsGetFirmwarePreferenceOutputListImage][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_firmware_preference_output_get_list_gir ()

gboolean
qmi_message_dms_get_firmware_preference_output_get_list_gir
                               (QmiMessageDmsGetFirmwarePreferenceOutput *self,
                                GPtrArray **value_list_ptr,
                                GError **error);

Get the 'List' field from self .

Version of qmi_message_dms_get_firmware_preference_output_get_list() using arrays of pointers to structs instead of arrays of structs, for easier binding in other languages.

[rename-to qmi_message_dms_get_firmware_preference_output_get_list]

Parameters

self	a QmiMessageDmsGetFirmwarePreferenceOutput.
value_list_ptr	a placeholder for the output array of QmiMessageDmsGetFirmwarePreferenceOutputListImage elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` .	[out][optional][element-type QmiMessageDmsGetFirmwarePreferenceOutputListImage][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_firmware_preference_response_parse ()

QmiMessageDmsGetFirmwarePreferenceOutput *
qmi_message_dms_get_firmware_preference_response_parse
                               (QmiMessage *message,
                                GError **error);

Parses a QmiMessage and builds a QmiMessageDmsGetFirmwarePreferenceOutput 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 QmiMessageDmsGetFirmwarePreferenceOutput, or NULL if error is set. The returned value should be freed with qmi_message_dms_get_firmware_preference_output_unref().

Since: 1.34

qmi_client_dms_get_firmware_preference ()

void
qmi_client_dms_get_firmware_preference
                               (QmiClientDms *self,
                                gpointer unused,
                                guint timeout,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously sends a Get Firmware Preference 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_firmware_preference_finish() to get the result of the operation.

Parameters

self	a QmiClientDms.
unused	`NULL`. This message doesn't have any input bundle.
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_firmware_preference_finish ()

QmiMessageDmsGetFirmwarePreferenceOutput *
qmi_client_dms_get_firmware_preference_finish
                               (QmiClientDms *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_dms_get_firmware_preference().

Parameters

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

Returns

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

Since: 1.0

Types and Values

QmiMessageDmsGetFirmwarePreferenceOutput

typedef struct _QmiMessageDmsGetFirmwarePreferenceOutput QmiMessageDmsGetFirmwarePreferenceOutput;

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

Since: 1.0

QmiMessageDmsGetFirmwarePreferenceOutputListImage

typedef struct {
    QmiDmsFirmwareImageType type;
    GArray *unique_id;
    gchar *build_id;
} QmiMessageDmsGetFirmwarePreferenceOutputListImage;

A QmiMessageDmsGetFirmwarePreferenceOutputListImage struct.

Members

QmiDmsFirmwareImageType `type`;	a QmiDmsFirmwareImageType.
GArray *`unique_id`;	a GArray of guint8 elements.
gchar *`build_id`;	a string.

Since: 1.0