libqmi-glib Reference Manual: WDS Get Current Settings

WDS Get Current Settings

Functions

QmiMessageWdsGetCurrentSettingsInput *	qmi_message_wds_get_current_settings_input_new ()
QmiMessageWdsGetCurrentSettingsInput *	qmi_message_wds_get_current_settings_input_ref ()
void	qmi_message_wds_get_current_settings_input_unref ()
gboolean	qmi_message_wds_get_current_settings_input_get_requested_settings ()
gboolean	qmi_message_wds_get_current_settings_input_set_requested_settings ()
QmiMessageWdsGetCurrentSettingsOutput *	qmi_message_wds_get_current_settings_output_ref ()
void	qmi_message_wds_get_current_settings_output_unref ()
gboolean	qmi_message_wds_get_current_settings_output_get_result ()
gboolean	qmi_message_wds_get_current_settings_output_get_profile_name ()
gboolean	qmi_message_wds_get_current_settings_output_get_pdp_type ()
gboolean	qmi_message_wds_get_current_settings_output_get_apn_name ()
gboolean	qmi_message_wds_get_current_settings_output_get_primary_ipv4_dns_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_secondary_ipv4_dns_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_gprs_granted_qos ()
gboolean	qmi_message_wds_get_current_settings_output_get_username ()
gboolean	qmi_message_wds_get_current_settings_output_get_authentication ()
gboolean	qmi_message_wds_get_current_settings_output_get_ipv4_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_profile_id ()
gboolean	qmi_message_wds_get_current_settings_output_get_ipv4_gateway_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_ipv4_gateway_subnet_mask ()
gboolean	qmi_message_wds_get_current_settings_output_get_pcscf_address_using_pco ()
gboolean	qmi_message_wds_get_current_settings_output_get_pcscf_server_address_list ()
gboolean	qmi_message_wds_get_current_settings_output_get_pcscf_domain_name_list ()
gboolean	qmi_message_wds_get_current_settings_output_get_ipv6_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_ipv6_gateway_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_ipv6_primary_dns_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_ipv6_secondary_dns_address ()
gboolean	qmi_message_wds_get_current_settings_output_get_mtu ()
gboolean	qmi_message_wds_get_current_settings_output_get_domain_name_list ()
gboolean	qmi_message_wds_get_current_settings_output_get_ip_family ()
gboolean	qmi_message_wds_get_current_settings_output_get_imcn_flag ()
gboolean	qmi_message_wds_get_current_settings_output_get_extended_technology_preference ()
void	qmi_client_wds_get_current_settings ()
QmiMessageWdsGetCurrentSettingsOutput *	qmi_client_wds_get_current_settings_finish ()

Types and Values

	QmiMessageWdsGetCurrentSettingsInput
	QmiMessageWdsGetCurrentSettingsOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageWdsGetCurrentSettingsInput
    ╰── QmiMessageWdsGetCurrentSettingsOutput

Description

Functions

qmi_message_wds_get_current_settings_input_new ()

QmiMessageWdsGetCurrentSettingsInput *
qmi_message_wds_get_current_settings_input_new
                               (void);

Allocates a new QmiMessageWdsGetCurrentSettingsInput.

Returns

the newly created QmiMessageWdsGetCurrentSettingsInput. The returned value should be freed with qmi_message_wds_get_current_settings_input_unref().

qmi_message_wds_get_current_settings_input_ref ()

QmiMessageWdsGetCurrentSettingsInput *
qmi_message_wds_get_current_settings_input_ref
                               (QmiMessageWdsGetCurrentSettingsInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageWdsGetCurrentSettingsInput.

Returns

the new reference to self .

qmi_message_wds_get_current_settings_input_unref ()

void
qmi_message_wds_get_current_settings_input_unref
                               (QmiMessageWdsGetCurrentSettingsInput *self);

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

Parameters

self

a QmiMessageWdsGetCurrentSettingsInput.

qmi_message_wds_get_current_settings_input_get_requested_settings ()

gboolean
qmi_message_wds_get_current_settings_input_get_requested_settings
                               (QmiMessageWdsGetCurrentSettingsInput *self,
                                QmiWdsGetCurrentSettingsRequestedSettings *requested_settings,
                                GError **error);

Get the 'Requested Settings' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsInput.
requested_settings	a placeholder for the output QmiWdsGetCurrentSettingsRequestedSettings, 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_current_settings_input_set_requested_settings ()

gboolean
qmi_message_wds_get_current_settings_input_set_requested_settings
                               (QmiMessageWdsGetCurrentSettingsInput *self,
                                QmiWdsGetCurrentSettingsRequestedSettings requested_settings,
                                GError **error);

Set the 'Requested Settings' field in the message.

Parameters

self	a QmiMessageWdsGetCurrentSettingsInput.
requested_settings	a QmiWdsGetCurrentSettingsRequestedSettings.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

qmi_message_wds_get_current_settings_output_ref ()

QmiMessageWdsGetCurrentSettingsOutput *
qmi_message_wds_get_current_settings_output_ref
                               (QmiMessageWdsGetCurrentSettingsOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageWdsGetCurrentSettingsOutput.

Returns

the new reference to self .

qmi_message_wds_get_current_settings_output_unref ()

void
qmi_message_wds_get_current_settings_output_unref
                               (QmiMessageWdsGetCurrentSettingsOutput *self);

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

Parameters

self

a QmiMessageWdsGetCurrentSettingsOutput.

qmi_message_wds_get_current_settings_output_get_result ()

gboolean
qmi_message_wds_get_current_settings_output_get_result
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

qmi_message_wds_get_current_settings_output_get_profile_name ()

gboolean
qmi_message_wds_get_current_settings_output_get_profile_name
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                const gchar **profile_name,
                                GError **error);

Get the 'Profile Name' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
profile_name	a placeholder for the output constant string, 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_current_settings_output_get_pdp_type ()

gboolean
qmi_message_wds_get_current_settings_output_get_pdp_type
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                QmiWdsPdpType *pdp_type,
                                GError **error);

Get the 'PDP Type' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
pdp_type	a placeholder for the output QmiWdsPdpType, 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_current_settings_output_get_apn_name ()

gboolean
qmi_message_wds_get_current_settings_output_get_apn_name
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                const gchar **apn_name,
                                GError **error);

Get the 'APN Name' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
apn_name	a placeholder for the output constant string, 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_current_settings_output_get_primary_ipv4_dns_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_primary_ipv4_dns_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint32 *primary_ipv4_dns_address,
                                GError **error);

Get the 'Primary IPv4 DNS Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
primary_ipv4_dns_address	a placeholder for the output guint32, 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_current_settings_output_get_secondary_ipv4_dns_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_secondary_ipv4_dns_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint32 *secondary_ipv4_dns_address,
                                GError **error);

Get the 'Secondary IPv4 DNS Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
secondary_ipv4_dns_address	a placeholder for the output guint32, 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_current_settings_output_get_gprs_granted_qos ()

gboolean
qmi_message_wds_get_current_settings_output_get_gprs_granted_qos
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint32 *gprs_granted_qos_precedence_class,
                                guint32 *gprs_granted_qos_delay_class,
                                guint32 *gprs_granted_qos_reliability_class,
                                guint32 *gprs_granted_qos_peak_throughput_class,
                                guint32 *gprs_granted_qos_mean_throughput_class,
                                GError **error);

Get the 'GPRS Granted QoS' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
gprs_granted_qos_precedence_class	a placeholder for the output guint32, or `NULL` if not required.
gprs_granted_qos_delay_class	a placeholder for the output guint32, or `NULL` if not required.
gprs_granted_qos_reliability_class	a placeholder for the output guint32, or `NULL` if not required.
gprs_granted_qos_peak_throughput_class	a placeholder for the output guint32, or `NULL` if not required.
gprs_granted_qos_mean_throughput_class	a placeholder for the output guint32, 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_current_settings_output_get_username ()

gboolean
qmi_message_wds_get_current_settings_output_get_username
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                const gchar **username,
                                GError **error);

Get the 'Username' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
username	a placeholder for the output constant string, 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_current_settings_output_get_authentication ()

gboolean
qmi_message_wds_get_current_settings_output_get_authentication
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                QmiWdsAuthentication *authentication,
                                GError **error);

Get the 'Authentication' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
authentication	a placeholder for the output QmiWdsAuthentication, 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_current_settings_output_get_ipv4_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_ipv4_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint32 *ipv4_address,
                                GError **error);

Get the 'IPv4 Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ipv4_address	a placeholder for the output guint32, 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_current_settings_output_get_profile_id ()

gboolean
qmi_message_wds_get_current_settings_output_get_profile_id
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                QmiWdsProfileType *profile_id_profile_type,
                                guint8 *profile_id_profile_index,
                                GError **error);

Get the 'Profile ID' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
profile_id_profile_type	a placeholder for the output QmiWdsProfileType, or `NULL` if not required.
profile_id_profile_index	a placeholder for the output guint8, 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_current_settings_output_get_ipv4_gateway_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_ipv4_gateway_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint32 *ipv4_gateway_address,
                                GError **error);

Get the 'IPv4 Gateway Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ipv4_gateway_address	a placeholder for the output guint32, 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_current_settings_output_get_ipv4_gateway_subnet_mask ()

gboolean
qmi_message_wds_get_current_settings_output_get_ipv4_gateway_subnet_mask
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint32 *ipv4_gateway_subnet_mask,
                                GError **error);

Get the 'IPv4 Gateway Subnet Mask' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ipv4_gateway_subnet_mask	a placeholder for the output guint32, 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_current_settings_output_get_pcscf_address_using_pco ()

gboolean
qmi_message_wds_get_current_settings_output_get_pcscf_address_using_pco
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint8 *pcscf_address_using_pco,
                                GError **error);

Get the 'PCSCF Address Using PCO' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
pcscf_address_using_pco	a placeholder for the output guint8, 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_current_settings_output_get_pcscf_server_address_list ()

gboolean
qmi_message_wds_get_current_settings_output_get_pcscf_server_address_list
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GArray **pcscf_server_address_list,
                                GError **error);

Get the 'PCSCF Server Address List' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
pcscf_server_address_list	a placeholder for the output GArray of guint32 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_current_settings_output_get_pcscf_domain_name_list ()

gboolean
qmi_message_wds_get_current_settings_output_get_pcscf_domain_name_list
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GArray **pcscf_domain_name_list,
                                GError **error);

Get the 'PCSCF Domain Name List' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
pcscf_domain_name_list	a placeholder for the output GArray of gchar * 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_current_settings_output_get_ipv6_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_ipv6_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GArray **ipv6_address_address,
                                guint8 *ipv6_address_prefix_length,
                                GError **error);

Get the 'IPv6 Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ipv6_address_address	a placeholder for the output GArray of guint16 elements, or `NULL` if not required. Do not free it, it is owned by `self` .
ipv6_address_prefix_length	a placeholder for the output guint8, 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_current_settings_output_get_ipv6_gateway_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_ipv6_gateway_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GArray **ipv6_gateway_address_address,
                                guint8 *ipv6_gateway_address_prefix_length,
                                GError **error);

Get the 'IPv6 Gateway Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ipv6_gateway_address_address	a placeholder for the output GArray of guint16 elements, or `NULL` if not required. Do not free it, it is owned by `self` .
ipv6_gateway_address_prefix_length	a placeholder for the output guint8, 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_current_settings_output_get_ipv6_primary_dns_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_ipv6_primary_dns_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GArray **ipv6_primary_dns_address,
                                GError **error);

Get the 'IPv6 Primary DNS Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ipv6_primary_dns_address	a placeholder for the output GArray of guint16 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_current_settings_output_get_ipv6_secondary_dns_address ()

gboolean
qmi_message_wds_get_current_settings_output_get_ipv6_secondary_dns_address
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GArray **ipv6_secondary_dns_address,
                                GError **error);

Get the 'IPv6 Secondary DNS Address' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ipv6_secondary_dns_address	a placeholder for the output GArray of guint16 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_current_settings_output_get_mtu ()

gboolean
qmi_message_wds_get_current_settings_output_get_mtu
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                guint32 *mtu,
                                GError **error);

Get the 'MTU' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
mtu	a placeholder for the output guint32, 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_current_settings_output_get_domain_name_list ()

gboolean
qmi_message_wds_get_current_settings_output_get_domain_name_list
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                GArray **domain_name_list,
                                GError **error);

Get the 'Domain Name List' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
domain_name_list	a placeholder for the output GArray of gchar * 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_current_settings_output_get_ip_family ()

gboolean
qmi_message_wds_get_current_settings_output_get_ip_family
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                QmiWdsIpFamily *ip_family,
                                GError **error);

Get the 'IP Family' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
ip_family	a placeholder for the output QmiWdsIpFamily, 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_current_settings_output_get_imcn_flag ()

gboolean
qmi_message_wds_get_current_settings_output_get_imcn_flag
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                gint8 *imcn_flag,
                                GError **error);

Get the 'IMCN Flag' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
imcn_flag	a placeholder for the output gint8, 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_current_settings_output_get_extended_technology_preference ()

gboolean
qmi_message_wds_get_current_settings_output_get_extended_technology_preference
                               (QmiMessageWdsGetCurrentSettingsOutput *self,
                                QmiWdsExtendedTechnologyPreference *extended_technology_preference,
                                GError **error);

Get the 'Extended Technology Preference' field from self .

Parameters

self	a QmiMessageWdsGetCurrentSettingsOutput.
extended_technology_preference	a placeholder for the output QmiWdsExtendedTechnologyPreference, 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_current_settings ()

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

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

Parameters

self	a QmiClientWds.
input	a QmiMessageWdsGetCurrentSettingsInput.
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_current_settings_finish ()

QmiMessageWdsGetCurrentSettingsOutput *
qmi_client_wds_get_current_settings_finish
                               (QmiClientWds *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_wds_get_current_settings().

Parameters

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

Returns

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

Types and Values

QmiMessageWdsGetCurrentSettingsInput

typedef struct _QmiMessageWdsGetCurrentSettingsInput QmiMessageWdsGetCurrentSettingsInput;

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

QmiMessageWdsGetCurrentSettingsOutput

typedef struct _QmiMessageWdsGetCurrentSettingsOutput QmiMessageWdsGetCurrentSettingsOutput;

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