WDS Get Profile List

WDS Get Profile List

Synopsis

                    QmiMessageWdsGetProfileListInput;
                    QmiMessageWdsGetProfileListOutput;
                    QmiMessageWdsGetProfileListOutputProfileListProfile;

QmiMessageWdsGetProfileListInput * qmi_message_wds_get_profile_list_input_new
                                                        (void);
QmiMessageWdsGetProfileListInput * qmi_message_wds_get_profile_list_input_ref
                                                        (QmiMessageWdsGetProfileListInput *self);
void                qmi_message_wds_get_profile_list_input_unref
                                                        (QmiMessageWdsGetProfileListInput *self);
gboolean            qmi_message_wds_get_profile_list_input_get_profile_type
                                                        (QmiMessageWdsGetProfileListInput *self,
                                                         QmiWdsProfileType *profile_type,
                                                         GError **error);
gboolean            qmi_message_wds_get_profile_list_input_set_profile_type
                                                        (QmiMessageWdsGetProfileListInput *self,
                                                         QmiWdsProfileType profile_type,
                                                         GError **error);

QmiMessageWdsGetProfileListOutput * qmi_message_wds_get_profile_list_output_ref
                                                        (QmiMessageWdsGetProfileListOutput *self);
void                qmi_message_wds_get_profile_list_output_unref
                                                        (QmiMessageWdsGetProfileListOutput *self);
gboolean            qmi_message_wds_get_profile_list_output_get_result
                                                        (QmiMessageWdsGetProfileListOutput *self,
                                                         GError **error);
gboolean            qmi_message_wds_get_profile_list_output_get_profile_list
                                                        (QmiMessageWdsGetProfileListOutput *self,
                                                         GArray **profile_list,
                                                         GError **error);
gboolean            qmi_message_wds_get_profile_list_output_get_extended_error_code
                                                        (QmiMessageWdsGetProfileListOutput *self,
                                                         QmiWdsDsProfileError *extended_error_code,
                                                         GError **error);

void                qmi_client_wds_get_profile_list     (QmiClientWds *self,
                                                         QmiMessageWdsGetProfileListInput *input,
                                                         guint timeout,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
QmiMessageWdsGetProfileListOutput * qmi_client_wds_get_profile_list_finish
                                                        (QmiClientWds *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Object Hierarchy

  GBoxed
   +----QmiMessageWdsGetProfileListInput

  GBoxed
   +----QmiMessageWdsGetProfileListOutput

Description

Details

QmiMessageWdsGetProfileListInput

typedef struct _QmiMessageWdsGetProfileListInput QmiMessageWdsGetProfileListInput;

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

QmiMessageWdsGetProfileListOutput

typedef struct _QmiMessageWdsGetProfileListOutput QmiMessageWdsGetProfileListOutput;

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

QmiMessageWdsGetProfileListOutputProfileListProfile

typedef struct {
    QmiWdsProfileType profile_type;
    guint8 profile_index;
    gchar * profile_name;
} QmiMessageWdsGetProfileListOutputProfileListProfile;

A QmiMessageWdsGetProfileListOutputProfileListProfile struct.

QmiWdsProfileType profile_type;

 a QmiWdsProfileType.

guint8 profile_index;

 a guint8.

gchar *profile_name;

 a string.

qmi_message_wds_get_profile_list_input_new ()

QmiMessageWdsGetProfileListInput * qmi_message_wds_get_profile_list_input_new
                                                        (void);

Allocates a new QmiMessageWdsGetProfileListInput.

Returns :

 the newly created QmiMessageWdsGetProfileListInput. The returned value should be freed with qmi_message_wds_get_profile_list_input_unref().

qmi_message_wds_get_profile_list_input_ref ()

QmiMessageWdsGetProfileListInput * qmi_message_wds_get_profile_list_input_ref
                                                        (QmiMessageWdsGetProfileListInput *self);

Atomically increments the reference count of self by one.

self :

 a QmiMessageWdsGetProfileListInput.

Returns :

 the new reference to self.

qmi_message_wds_get_profile_list_input_unref ()

void                qmi_message_wds_get_profile_list_input_unref
                                                        (QmiMessageWdsGetProfileListInput *self);

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

self :

 a QmiMessageWdsGetProfileListInput.

qmi_message_wds_get_profile_list_input_get_profile_type ()

gboolean            qmi_message_wds_get_profile_list_input_get_profile_type
                                                        (QmiMessageWdsGetProfileListInput *self,
                                                         QmiWdsProfileType *profile_type,
                                                         GError **error);

Get the 'Profile Type' field from self.

self :

 a QmiMessageWdsGetProfileListInput.

profile_type :

 a placeholder for the output QmiWdsProfileType, or NULL if not required.

error :

 Return location for error or NULL.

Returns :

 TRUE if the field is found, FALSE otherwise.

qmi_message_wds_get_profile_list_input_set_profile_type ()

gboolean            qmi_message_wds_get_profile_list_input_set_profile_type
                                                        (QmiMessageWdsGetProfileListInput *self,
                                                         QmiWdsProfileType profile_type,
                                                         GError **error);

Set the 'Profile Type' field in the message.

self :

 a QmiMessageWdsGetProfileListInput.

profile_type :

 a QmiWdsProfileType.

error :

 Return location for error or NULL.

Returns :

 TRUE if value was successfully set, FALSE otherwise.

qmi_message_wds_get_profile_list_output_ref ()

QmiMessageWdsGetProfileListOutput * qmi_message_wds_get_profile_list_output_ref
                                                        (QmiMessageWdsGetProfileListOutput *self);

Atomically increments the reference count of self by one.

self :

 a QmiMessageWdsGetProfileListOutput.

Returns :

 the new reference to self.

qmi_message_wds_get_profile_list_output_unref ()

void                qmi_message_wds_get_profile_list_output_unref
                                                        (QmiMessageWdsGetProfileListOutput *self);

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

self :

 a QmiMessageWdsGetProfileListOutput.

qmi_message_wds_get_profile_list_output_get_result ()

gboolean            qmi_message_wds_get_profile_list_output_get_result
                                                        (QmiMessageWdsGetProfileListOutput *self,
                                                         GError **error);

Get the result of the QMI operation.

self :

 a QmiMessageWdsGetProfileListOutput.

error :

 Return location for error or NULL.

Returns :

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

qmi_message_wds_get_profile_list_output_get_profile_list ()

gboolean            qmi_message_wds_get_profile_list_output_get_profile_list
                                                        (QmiMessageWdsGetProfileListOutput *self,
                                                         GArray **profile_list,
                                                         GError **error);

Get the 'Profile List' field from self.

self :

 a QmiMessageWdsGetProfileListOutput.

profile_list :

 a placeholder for the output GArray of QmiMessageWdsGetProfileListOutputProfileListProfile elements, or NULL if not required. Do not free it, it is owned by self.

error :

 Return location for error or NULL.

Returns :

 TRUE if the field is found, FALSE otherwise.

qmi_message_wds_get_profile_list_output_get_extended_error_code ()

gboolean            qmi_message_wds_get_profile_list_output_get_extended_error_code
                                                        (QmiMessageWdsGetProfileListOutput *self,
                                                         QmiWdsDsProfileError *extended_error_code,
                                                         GError **error);

Get the 'Extended Error Code' field from self.

self :

 a QmiMessageWdsGetProfileListOutput.

extended_error_code :

 a placeholder for the output QmiWdsDsProfileError, or NULL if not required.

error :

 Return location for error or NULL.

Returns :

 TRUE if the field is found, FALSE otherwise.

qmi_client_wds_get_profile_list ()

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

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

self :

 a QmiClientWds.

input :

 a QmiMessageWdsGetProfileListInput.

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.

qmi_client_wds_get_profile_list_finish ()

QmiMessageWdsGetProfileListOutput * qmi_client_wds_get_profile_list_finish
                                                        (QmiClientWds *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an async operation started with qmi_client_wds_get_profile_list().

self :

 a QmiClientWds.

res :

 the GAsyncResult obtained from the GAsyncReadyCallback passed to qmi_client_wds_get_profile_list().

error :

 Return location for error or NULL.

Returns :

 a QmiMessageWdsGetProfileListOutput, or NULL if error is set. The returned value should be freed with qmi_message_wds_get_profile_list_output_unref().
Generated by GTK-Doc V1.19