WDS Configure Profile Event List response: libqmi-glib Reference Manual

WDS Configure Profile Event List response

WDS Configure Profile Event List response — Methods to manage the WDS Configure Profile Event List response.

Functions

QmiMessageWdsConfigureProfileEventListInput *	qmi_message_wds_configure_profile_event_list_input_new ()
QmiMessageWdsConfigureProfileEventListInput *	qmi_message_wds_configure_profile_event_list_input_ref ()
void	qmi_message_wds_configure_profile_event_list_input_unref ()
gboolean	qmi_message_wds_configure_profile_event_list_input_get_register ()
gboolean	qmi_message_wds_configure_profile_event_list_input_get_register_gir ()
gboolean	qmi_message_wds_configure_profile_event_list_input_set_register ()
gboolean	qmi_message_wds_configure_profile_event_list_input_set_register_gir ()
QmiMessageWdsConfigureProfileEventListOutput *	qmi_message_wds_configure_profile_event_list_output_ref ()
void	qmi_message_wds_configure_profile_event_list_output_unref ()
gboolean	qmi_message_wds_configure_profile_event_list_output_get_result ()
QmiMessageWdsConfigureProfileEventListOutput *	qmi_message_wds_configure_profile_event_list_response_parse ()
void	qmi_client_wds_configure_profile_event_list ()
QmiMessageWdsConfigureProfileEventListOutput *	qmi_client_wds_configure_profile_event_list_finish ()

Types and Values

	QmiMessageWdsConfigureProfileEventListInput
	QmiMessageWdsConfigureProfileEventListInputRegisterElement
	QmiMessageWdsConfigureProfileEventListOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageWdsConfigureProfileEventListInput
    ├── QmiMessageWdsConfigureProfileEventListInputRegisterElement
    ╰── QmiMessageWdsConfigureProfileEventListOutput

Description

Collection of methods to create requests and parse responses of the WDS Configure Profile Event List message.

Functions

qmi_message_wds_configure_profile_event_list_input_new ()

QmiMessageWdsConfigureProfileEventListInput *
qmi_message_wds_configure_profile_event_list_input_new
                               (void);

Allocates a new QmiMessageWdsConfigureProfileEventListInput.

Returns

the newly created QmiMessageWdsConfigureProfileEventListInput. The returned value should be freed with qmi_message_wds_configure_profile_event_list_input_unref().

Since: 1.34

qmi_message_wds_configure_profile_event_list_input_ref ()

QmiMessageWdsConfigureProfileEventListInput *
qmi_message_wds_configure_profile_event_list_input_ref
                               (QmiMessageWdsConfigureProfileEventListInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageWdsConfigureProfileEventListInput.

Returns

the new reference to self .

Since: 1.34

qmi_message_wds_configure_profile_event_list_input_unref ()

void
qmi_message_wds_configure_profile_event_list_input_unref
                               (QmiMessageWdsConfigureProfileEventListInput *self);

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

Parameters

self

a QmiMessageWdsConfigureProfileEventListInput.

Since: 1.34

qmi_message_wds_configure_profile_event_list_input_get_register ()

gboolean
qmi_message_wds_configure_profile_event_list_input_get_register
                               (QmiMessageWdsConfigureProfileEventListInput *self,
                                GArray **value_register,
                                GError **error);

Get the 'Register' field from self .

[skip]

Parameters

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

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.34

qmi_message_wds_configure_profile_event_list_input_get_register_gir ()

gboolean
qmi_message_wds_configure_profile_event_list_input_get_register_gir
                               (QmiMessageWdsConfigureProfileEventListInput *self,
                                GPtrArray **value_register_ptr,
                                GError **error);

Get the 'Register' field from self .

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

[rename-to qmi_message_wds_configure_profile_event_list_input_get_register]

Parameters

self	a QmiMessageWdsConfigureProfileEventListInput.
value_register_ptr	a placeholder for the output array of QmiMessageWdsConfigureProfileEventListInputRegisterElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` .	[out][optional][element-type QmiMessageWdsConfigureProfileEventListInputRegisterElement][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.34

qmi_message_wds_configure_profile_event_list_input_set_register ()

gboolean
qmi_message_wds_configure_profile_event_list_input_set_register
                               (QmiMessageWdsConfigureProfileEventListInput *self,
                                GArray *value_register,
                                GError **error);

Set the 'Register' field in the message.

[skip]

Parameters

self	a QmiMessageWdsConfigureProfileEventListInput.
value_register	a GArray of QmiMessageWdsConfigureProfileEventListInputRegisterElement elements. A new reference to `value_register` 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 QmiMessageWdsConfigureProfileEventListInputRegisterElement][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.34

qmi_message_wds_configure_profile_event_list_input_set_register_gir ()

gboolean
qmi_message_wds_configure_profile_event_list_input_set_register_gir
                               (QmiMessageWdsConfigureProfileEventListInput *self,
                                GPtrArray *value_register_ptr,
                                GError **error);

Set the 'Register' field in the message.

[rename-to qmi_message_wds_configure_profile_event_list_input_set_register]

Parameters

self	a QmiMessageWdsConfigureProfileEventListInput.
value_register_ptr	array of QmiMessageWdsConfigureProfileEventListInputRegisterElement elements. The contents of the given array will be copied, the GPtrArray will not increase its reference count.	[in][element-type QmiMessageWdsConfigureProfileEventListInputRegisterElement][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.34

qmi_message_wds_configure_profile_event_list_output_ref ()

QmiMessageWdsConfigureProfileEventListOutput *
qmi_message_wds_configure_profile_event_list_output_ref
                               (QmiMessageWdsConfigureProfileEventListOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageWdsConfigureProfileEventListOutput.

Returns

the new reference to self .

Since: 1.34

qmi_message_wds_configure_profile_event_list_output_unref ()

void
qmi_message_wds_configure_profile_event_list_output_unref
                               (QmiMessageWdsConfigureProfileEventListOutput *self);

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

Parameters

self

a QmiMessageWdsConfigureProfileEventListOutput.

Since: 1.34

qmi_message_wds_configure_profile_event_list_output_get_result ()

gboolean
qmi_message_wds_configure_profile_event_list_output_get_result
                               (QmiMessageWdsConfigureProfileEventListOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.34

qmi_message_wds_configure_profile_event_list_response_parse ()

QmiMessageWdsConfigureProfileEventListOutput *
qmi_message_wds_configure_profile_event_list_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.34

qmi_client_wds_configure_profile_event_list ()

void
qmi_client_wds_configure_profile_event_list
                               (QmiClientWds *self,
                                QmiMessageWdsConfigureProfileEventListInput *input,
                                guint timeout,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously sends a Configure Profile Event List 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_wds_configure_profile_event_list_finish() to get the result of the operation.

Parameters

self	a QmiClientWds.
input	a QmiMessageWdsConfigureProfileEventListInput.
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.34

qmi_client_wds_configure_profile_event_list_finish ()

QmiMessageWdsConfigureProfileEventListOutput *
qmi_client_wds_configure_profile_event_list_finish
                               (QmiClientWds *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_wds_configure_profile_event_list().

Parameters

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

Returns

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

Since: 1.34

Types and Values

QmiMessageWdsConfigureProfileEventListInput

typedef struct _QmiMessageWdsConfigureProfileEventListInput QmiMessageWdsConfigureProfileEventListInput;

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

Since: 1.34

QmiMessageWdsConfigureProfileEventListInputRegisterElement

typedef struct {
    QmiWdsProfileType profile_type;
    guint8 profile_index;
} QmiMessageWdsConfigureProfileEventListInputRegisterElement;

A QmiMessageWdsConfigureProfileEventListInputRegisterElement struct.

Members

QmiWdsProfileType `profile_type`;	a QmiWdsProfileType.
guint8 `profile_index`;	a guint8.

Since: 1.34

QmiMessageWdsConfigureProfileEventListOutput

typedef struct _QmiMessageWdsConfigureProfileEventListOutput QmiMessageWdsConfigureProfileEventListOutput;

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

Since: 1.34