WDS Get Channel Rates request: libqmi-glib Reference Manual

## WDS Get Channel Rates request WDS Get Channel Rates request |

## Functions

QmiMessageWdsGetChannelRatesOutput * | qmi_message_wds_get_channel_rates_output_ref ()
void | qmi_message_wds_get_channel_rates_output_unref ()
gboolean | qmi_message_wds_get_channel_rates_output_get_channel_rates ()
gboolean | qmi_message_wds_get_channel_rates_output_get_result ()
void | qmi_client_wds_get_channel_rates ()
QmiMessageWdsGetChannelRatesOutput * | qmi_client_wds_get_channel_rates_finish ()

## Types and Values

| QmiMessageWdsGetChannelRatesOutput

## Object Hierarchy

        GBoxed
        ╰── QmiMessageWdsGetChannelRatesOutput

## Description

## Functions

### qmi_message_wds_get_channel_rates_output_ref ()

    QmiMessageWdsGetChannelRatesOutput *
    qmi_message_wds_get_channel_rates_output_ref
                                   (QmiMessageWdsGetChannelRatesOutput *self);

Atomically increments the reference count of `self` by one.

#### Parameters

self | a QmiMessageWdsGetChannelRatesOutput. |

#### Returns

the new reference to `self` .

Since: 1.20

### qmi_message_wds_get_channel_rates_output_unref ()

    void
    qmi_message_wds_get_channel_rates_output_unref
                                   (QmiMessageWdsGetChannelRatesOutput *self);

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

#### Parameters

self | a QmiMessageWdsGetChannelRatesOutput. |

Since: 1.20

### qmi_message_wds_get_channel_rates_output_get_channel_rates ()

    gboolean
    qmi_message_wds_get_channel_rates_output_get_channel_rates
                                   (QmiMessageWdsGetChannelRatesOutput *self,
                                    guint32 *value_channel_rates_channel_tx_rate_bps,
                                    guint32 *value_channel_rates_channel_rx_rate_bps,
                                    guint32 *value_channel_rates_max_channel_tx_rate_bps,
                                    guint32 *value_channel_rates_max_channel_rx_rate_bps,
                                    GError **error);

Get the 'Channel Rates' field from `self` .

#### Parameters

self | a QmiMessageWdsGetChannelRatesOutput. |
value_channel_rates_channel_tx_rate_bps | a placeholder for the output guint32, or `NULL` if not required. |
value_channel_rates_channel_rx_rate_bps | a placeholder for the output guint32, or `NULL` if not required. |
value_channel_rates_max_channel_tx_rate_bps | a placeholder for the output guint32, or `NULL` if not required. |
value_channel_rates_max_channel_rx_rate_bps | 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.

Since: 1.0

### qmi_message_wds_get_channel_rates_output_get_result ()

    gboolean
    qmi_message_wds_get_channel_rates_output_get_result
                                   (QmiMessageWdsGetChannelRatesOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

self | a QmiMessageWdsGetChannelRatesOutput. |
error | Return location for error or `NULL`. |

#### Returns

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

Since: 1.20

### qmi_client_wds_get_channel_rates ()

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

Asynchronously sends a Get Channel Rates 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_channel_rates_finish()` to get the result of the operation.

#### Parameters

self | a QmiClientWds. |
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.20

### qmi_client_wds_get_channel_rates_finish ()

    QmiMessageWdsGetChannelRatesOutput *
    qmi_client_wds_get_channel_rates_finish
                                   (QmiClientWds *self,
                                    GAsyncResult *res,
                                    GError **error);

Finishes an async operation started with `qmi_client_wds_get_channel_rates()`.

#### Parameters

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

#### Returns

a QmiMessageWdsGetChannelRatesOutput, or `NULL` if `error` is set. The returned value should be freed with `qmi_message_wds_get_channel_rates_output_unref()`.

Since: 1.20

## Types and Values

### QmiMessageWdsGetChannelRatesOutput

    typedef struct _QmiMessageWdsGetChannelRatesOutput QmiMessageWdsGetChannelRatesOutput;

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

Since: 1.20