DMS Get Band Capabilities response: libqmi-glib Reference Manual

DMS Get Band Capabilities response

DMS Get Band Capabilities response — Methods to manage the DMS Get Band Capabilities response.

Functions

QmiMessageDmsGetBandCapabilitiesOutput *	qmi_message_dms_get_band_capabilities_output_ref ()
void	qmi_message_dms_get_band_capabilities_output_unref ()
gboolean	qmi_message_dms_get_band_capabilities_output_get_result ()
gboolean	qmi_message_dms_get_band_capabilities_output_get_band_capability ()
gboolean	qmi_message_dms_get_band_capabilities_output_get_lte_band_capability ()
gboolean	qmi_message_dms_get_band_capabilities_output_get_extended_lte_band_capability ()
gboolean	qmi_message_dms_get_band_capabilities_output_get_nr5g_band_capability ()
QmiMessageDmsGetBandCapabilitiesOutput *	qmi_message_dms_get_band_capabilities_response_parse ()
void	qmi_client_dms_get_band_capabilities ()
QmiMessageDmsGetBandCapabilitiesOutput *	qmi_client_dms_get_band_capabilities_finish ()

Types and Values

QmiMessageDmsGetBandCapabilitiesOutput

Object Hierarchy

    GBoxed
    ╰── QmiMessageDmsGetBandCapabilitiesOutput

Description

Collection of methods to create requests and parse responses of the DMS Get Band Capabilities message.

Functions

qmi_message_dms_get_band_capabilities_output_ref ()

QmiMessageDmsGetBandCapabilitiesOutput *
qmi_message_dms_get_band_capabilities_output_ref
                               (QmiMessageDmsGetBandCapabilitiesOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageDmsGetBandCapabilitiesOutput.

Returns

the new reference to self .

Since: 1.0

qmi_message_dms_get_band_capabilities_output_unref ()

void
qmi_message_dms_get_band_capabilities_output_unref
                               (QmiMessageDmsGetBandCapabilitiesOutput *self);

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

Parameters

self

a QmiMessageDmsGetBandCapabilitiesOutput.

Since: 1.0

qmi_message_dms_get_band_capabilities_output_get_result ()

gboolean
qmi_message_dms_get_band_capabilities_output_get_result
                               (QmiMessageDmsGetBandCapabilitiesOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

self	a QmiMessageDmsGetBandCapabilitiesOutput.
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_band_capabilities_output_get_band_capability ()

gboolean
qmi_message_dms_get_band_capabilities_output_get_band_capability
                               (QmiMessageDmsGetBandCapabilitiesOutput *self,
                                QmiDmsBandCapability *value_band_capability,
                                GError **error);

Get the 'Band Capability' field from self .

Parameters

self	a QmiMessageDmsGetBandCapabilitiesOutput.
value_band_capability	a placeholder for the output QmiDmsBandCapability, 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_band_capabilities_output_get_lte_band_capability ()

gboolean
qmi_message_dms_get_band_capabilities_output_get_lte_band_capability
                               (QmiMessageDmsGetBandCapabilitiesOutput *self,
                                QmiDmsLteBandCapability *value_lte_band_capability,
                                GError **error);

Get the 'LTE Band Capability' field from self .

Parameters

self	a QmiMessageDmsGetBandCapabilitiesOutput.
value_lte_band_capability	a placeholder for the output QmiDmsLteBandCapability, 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_band_capabilities_output_get_extended_lte_band_capability ()

gboolean
qmi_message_dms_get_band_capabilities_output_get_extended_lte_band_capability
                               (QmiMessageDmsGetBandCapabilitiesOutput *self,
                                GArray **value_extended_lte_band_capability,
                                GError **error);

Get the 'Extended LTE Band Capability' field from self .

Parameters

self	a QmiMessageDmsGetBandCapabilitiesOutput.
value_extended_lte_band_capability	a placeholder for the output GArray of guint16 elements, or `NULL` if not required. Do not free it, it is owned by `self` .	[out][optional][element-type guint16][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.20

qmi_message_dms_get_band_capabilities_output_get_nr5g_band_capability ()

gboolean
qmi_message_dms_get_band_capabilities_output_get_nr5g_band_capability
                               (QmiMessageDmsGetBandCapabilitiesOutput *self,
                                GArray **value_nr5g_band_capability,
                                GError **error);

Get the 'NR5G Band Capability' field from self .

Parameters

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

QmiMessageDmsGetBandCapabilitiesOutput *
qmi_message_dms_get_band_capabilities_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.34

qmi_client_dms_get_band_capabilities ()

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

Asynchronously sends a Get Band Capabilities 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_band_capabilities_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_band_capabilities_finish ()

QmiMessageDmsGetBandCapabilitiesOutput *
qmi_client_dms_get_band_capabilities_finish
                               (QmiClientDms *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_dms_get_band_capabilities().

Parameters

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

Returns

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

Since: 1.0

Types and Values

QmiMessageDmsGetBandCapabilitiesOutput

typedef struct _QmiMessageDmsGetBandCapabilitiesOutput QmiMessageDmsGetBandCapabilitiesOutput;

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

Since: 1.0