GAS DMS Set USB Composition response: libqmi-glib Reference Manual

GAS DMS Set USB Composition response

GAS DMS Set USB Composition response — Methods to manage the GAS DMS Set USB Composition response.

Functions

QmiMessageGasDmsSetUsbCompositionInput *	qmi_message_gas_dms_set_usb_composition_input_new ()
QmiMessageGasDmsSetUsbCompositionInput *	qmi_message_gas_dms_set_usb_composition_input_ref ()
void	qmi_message_gas_dms_set_usb_composition_input_unref ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_get_reboot_after_setting ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_set_reboot_after_setting ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_get_immediate_setting ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_set_immediate_setting ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_get_composition_persistence ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_set_composition_persistence ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_get_endpoint_type ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_set_endpoint_type ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_get_usb_composition ()
gboolean	qmi_message_gas_dms_set_usb_composition_input_set_usb_composition ()
QmiMessageGasDmsSetUsbCompositionOutput *	qmi_message_gas_dms_set_usb_composition_output_ref ()
void	qmi_message_gas_dms_set_usb_composition_output_unref ()
gboolean	qmi_message_gas_dms_set_usb_composition_output_get_result ()
QmiMessageGasDmsSetUsbCompositionOutput *	qmi_message_gas_dms_set_usb_composition_response_parse ()
void	qmi_client_gas_dms_set_usb_composition ()
QmiMessageGasDmsSetUsbCompositionOutput *	qmi_client_gas_dms_set_usb_composition_finish ()

Types and Values

	QmiMessageGasDmsSetUsbCompositionInput
	QmiMessageGasDmsSetUsbCompositionOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageGasDmsSetUsbCompositionInput
    ╰── QmiMessageGasDmsSetUsbCompositionOutput

Description

Collection of methods to create requests and parse responses of the GAS DMS Set USB Composition message.

Functions

qmi_message_gas_dms_set_usb_composition_input_new ()

QmiMessageGasDmsSetUsbCompositionInput *
qmi_message_gas_dms_set_usb_composition_input_new
                               (void);

Allocates a new QmiMessageGasDmsSetUsbCompositionInput.

Returns

the newly created QmiMessageGasDmsSetUsbCompositionInput. The returned value should be freed with qmi_message_gas_dms_set_usb_composition_input_unref().

Since: 1.32

qmi_message_gas_dms_set_usb_composition_input_ref ()

QmiMessageGasDmsSetUsbCompositionInput *
qmi_message_gas_dms_set_usb_composition_input_ref
                               (QmiMessageGasDmsSetUsbCompositionInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageGasDmsSetUsbCompositionInput.

Returns

the new reference to self .

Since: 1.32

qmi_message_gas_dms_set_usb_composition_input_unref ()

void
qmi_message_gas_dms_set_usb_composition_input_unref
                               (QmiMessageGasDmsSetUsbCompositionInput *self);

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

Parameters

self

a QmiMessageGasDmsSetUsbCompositionInput.

Since: 1.32

qmi_message_gas_dms_set_usb_composition_input_get_reboot_after_setting ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_get_reboot_after_setting
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                gboolean *value_reboot_after_setting,
                                GError **error);

Get the 'Reboot After Setting' field from self .

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_reboot_after_setting	a placeholder for the output gboolean, 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.32

qmi_message_gas_dms_set_usb_composition_input_set_reboot_after_setting ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_set_reboot_after_setting
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                gboolean value_reboot_after_setting,
                                GError **error);

Set the 'Reboot After Setting' field in the message.

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_reboot_after_setting	a gboolean.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.32

qmi_message_gas_dms_set_usb_composition_input_get_immediate_setting ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_get_immediate_setting
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                gboolean *value_immediate_setting,
                                GError **error);

Get the 'Immediate Setting' field from self .

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_immediate_setting	a placeholder for the output gboolean, 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.32

qmi_message_gas_dms_set_usb_composition_input_set_immediate_setting ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_set_immediate_setting
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                gboolean value_immediate_setting,
                                GError **error);

Set the 'Immediate Setting' field in the message.

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_immediate_setting	a gboolean.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.32

qmi_message_gas_dms_set_usb_composition_input_get_composition_persistence ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_get_composition_persistence
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                gboolean *value_composition_persistence,
                                GError **error);

Get the 'Composition Persistence' field from self .

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_composition_persistence	a placeholder for the output gboolean, 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.32

qmi_message_gas_dms_set_usb_composition_input_set_composition_persistence ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_set_composition_persistence
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                gboolean value_composition_persistence,
                                GError **error);

Set the 'Composition Persistence' field in the message.

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_composition_persistence	a gboolean.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.32

qmi_message_gas_dms_set_usb_composition_input_get_endpoint_type ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_get_endpoint_type
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                QmiGasUsbCompositionEndpointType *value_endpoint_type,
                                GError **error);

Get the 'Endpoint Type' field from self .

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_endpoint_type	a placeholder for the output QmiGasUsbCompositionEndpointType, 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.32

qmi_message_gas_dms_set_usb_composition_input_set_endpoint_type ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_set_endpoint_type
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                QmiGasUsbCompositionEndpointType value_endpoint_type,
                                GError **error);

Set the 'Endpoint Type' field in the message.

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_endpoint_type	a QmiGasUsbCompositionEndpointType.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.32

qmi_message_gas_dms_set_usb_composition_input_get_usb_composition ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_get_usb_composition
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                guint32 *value_usb_composition,
                                GError **error);

Get the 'USB Composition' field from self .

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_usb_composition	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.32

qmi_message_gas_dms_set_usb_composition_input_set_usb_composition ()

gboolean
qmi_message_gas_dms_set_usb_composition_input_set_usb_composition
                               (QmiMessageGasDmsSetUsbCompositionInput *self,
                                guint32 value_usb_composition,
                                GError **error);

Set the 'USB Composition' field in the message.

Parameters

self	a QmiMessageGasDmsSetUsbCompositionInput.
value_usb_composition	a guint32.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.32

qmi_message_gas_dms_set_usb_composition_output_ref ()

QmiMessageGasDmsSetUsbCompositionOutput *
qmi_message_gas_dms_set_usb_composition_output_ref
                               (QmiMessageGasDmsSetUsbCompositionOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageGasDmsSetUsbCompositionOutput.

Returns

the new reference to self .

Since: 1.32

qmi_message_gas_dms_set_usb_composition_output_unref ()

void
qmi_message_gas_dms_set_usb_composition_output_unref
                               (QmiMessageGasDmsSetUsbCompositionOutput *self);

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

Parameters

self

a QmiMessageGasDmsSetUsbCompositionOutput.

Since: 1.32

qmi_message_gas_dms_set_usb_composition_output_get_result ()

gboolean
qmi_message_gas_dms_set_usb_composition_output_get_result
                               (QmiMessageGasDmsSetUsbCompositionOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.32

qmi_message_gas_dms_set_usb_composition_response_parse ()

QmiMessageGasDmsSetUsbCompositionOutput *
qmi_message_gas_dms_set_usb_composition_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.34

qmi_client_gas_dms_set_usb_composition ()

void
qmi_client_gas_dms_set_usb_composition
                               (QmiClientGas *self,
                                QmiMessageGasDmsSetUsbCompositionInput *input,
                                guint timeout,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously sends a DMS Set USB Composition 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_gas_dms_set_usb_composition_finish() to get the result of the operation.

Parameters

self	a QmiClientGas.
input	a QmiMessageGasDmsSetUsbCompositionInput.
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.32

qmi_client_gas_dms_set_usb_composition_finish ()

QmiMessageGasDmsSetUsbCompositionOutput *
qmi_client_gas_dms_set_usb_composition_finish
                               (QmiClientGas *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_gas_dms_set_usb_composition().

Parameters

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

Returns

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

Since: 1.32

Types and Values

QmiMessageGasDmsSetUsbCompositionInput

typedef struct _QmiMessageGasDmsSetUsbCompositionInput QmiMessageGasDmsSetUsbCompositionInput;

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

Since: 1.32

QmiMessageGasDmsSetUsbCompositionOutput

typedef struct _QmiMessageGasDmsSetUsbCompositionOutput QmiMessageGasDmsSetUsbCompositionOutput;

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

Since: 1.32