WMS Get Supported Messages response: libqmi-glib Reference Manual

WMS Get Supported Messages response

WMS Get Supported Messages response — Methods to manage the WMS Get Supported Messages response.

Functions

QmiMessageWmsGetSupportedMessagesOutput *	qmi_message_wms_get_supported_messages_output_ref ()
void	qmi_message_wms_get_supported_messages_output_unref ()
gboolean	qmi_message_wms_get_supported_messages_output_get_result ()
gboolean	qmi_message_wms_get_supported_messages_output_get_list ()
QmiMessageWmsGetSupportedMessagesOutput *	qmi_message_wms_get_supported_messages_response_parse ()
void	qmi_client_wms_get_supported_messages ()
QmiMessageWmsGetSupportedMessagesOutput *	qmi_client_wms_get_supported_messages_finish ()

Types and Values

QmiMessageWmsGetSupportedMessagesOutput

Object Hierarchy

    GBoxed
    ╰── QmiMessageWmsGetSupportedMessagesOutput

Description

Collection of methods to create requests and parse responses of the WMS Get Supported Messages message.

Functions

qmi_message_wms_get_supported_messages_output_ref ()

QmiMessageWmsGetSupportedMessagesOutput *
qmi_message_wms_get_supported_messages_output_ref
                               (QmiMessageWmsGetSupportedMessagesOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageWmsGetSupportedMessagesOutput.

Returns

the new reference to self .

Since: 1.14

qmi_message_wms_get_supported_messages_output_unref ()

void
qmi_message_wms_get_supported_messages_output_unref
                               (QmiMessageWmsGetSupportedMessagesOutput *self);

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

Parameters

self

a QmiMessageWmsGetSupportedMessagesOutput.

Since: 1.14

qmi_message_wms_get_supported_messages_output_get_result ()

gboolean
qmi_message_wms_get_supported_messages_output_get_result
                               (QmiMessageWmsGetSupportedMessagesOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.14

qmi_message_wms_get_supported_messages_output_get_list ()

gboolean
qmi_message_wms_get_supported_messages_output_get_list
                               (QmiMessageWmsGetSupportedMessagesOutput *self,
                                GArray **value_list,
                                GError **error);

Get the 'List' field from self .

Parameters

self	a QmiMessageWmsGetSupportedMessagesOutput.
value_list	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]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.14

qmi_message_wms_get_supported_messages_response_parse ()

QmiMessageWmsGetSupportedMessagesOutput *
qmi_message_wms_get_supported_messages_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.34

qmi_client_wms_get_supported_messages ()

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

Asynchronously sends a Get Supported Messages 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_wms_get_supported_messages_finish() to get the result of the operation.

Parameters

self	a QmiClientWms.
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.14

qmi_client_wms_get_supported_messages_finish ()

QmiMessageWmsGetSupportedMessagesOutput *
qmi_client_wms_get_supported_messages_finish
                               (QmiClientWms *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_wms_get_supported_messages().

Parameters

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

Returns

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

Since: 1.14

Types and Values

QmiMessageWmsGetSupportedMessagesOutput

typedef struct _QmiMessageWmsGetSupportedMessagesOutput QmiMessageWmsGetSupportedMessagesOutput;

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

Since: 1.14