NAS Get LTE Cphy CA Info response: libqmi-glib Reference Manual

## NAS Get LTE Cphy CA Info response NAS Get LTE Cphy CA Info response — Methods to manage the NAS Get LTE Cphy CA Info response. |

## Functions

QmiMessageNasGetLteCphyCaInfoOutput * | qmi_message_nas_get_lte_cphy_ca_info_output_ref ()
void | qmi_message_nas_get_lte_cphy_ca_info_output_unref ()
gboolean | qmi_message_nas_get_lte_cphy_ca_info_output_get_result ()
gboolean | qmi_message_nas_get_lte_cphy_ca_info_output_get_dl_bandwidth ()
gboolean | qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_scell_info ()
gboolean | qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_pcell_info ()
gboolean | qmi_message_nas_get_lte_cphy_ca_info_output_get_scell_index ()
gboolean | qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_secondary_cells ()
gboolean | qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_secondary_cells_gir ()
QmiMessageNasGetLteCphyCaInfoOutput * | qmi_message_nas_get_lte_cphy_ca_info_response_parse ()
void | qmi_client_nas_get_lte_cphy_ca_info ()
QmiMessageNasGetLteCphyCaInfoOutput * | qmi_client_nas_get_lte_cphy_ca_info_finish ()

## Types and Values

| QmiMessageNasGetLteCphyCaInfoOutput
| QmiMessageNasGetLteCphyCaInfoOutputPhyCaAggSecondaryCellsSsc

## Object Hierarchy

        GBoxed
        ├── QmiMessageNasGetLteCphyCaInfoOutput
        ╰── QmiMessageNasGetLteCphyCaInfoOutputPhyCaAggSecondaryCellsSsc

## Description

Collection of methods to create requests and parse responses of the NAS Get LTE Cphy CA Info message.

## Functions

### qmi_message_nas_get_lte_cphy_ca_info_output_ref ()

    QmiMessageNasGetLteCphyCaInfoOutput *
    qmi_message_nas_get_lte_cphy_ca_info_output_ref
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self);

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

#### Parameters

self | a QmiMessageNasGetLteCphyCaInfoOutput. |

#### Returns

the new reference to `self` .

Since: 1.16

### qmi_message_nas_get_lte_cphy_ca_info_output_unref ()

    void
    qmi_message_nas_get_lte_cphy_ca_info_output_unref
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self);

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

#### Parameters

self | a QmiMessageNasGetLteCphyCaInfoOutput. |

Since: 1.16

### qmi_message_nas_get_lte_cphy_ca_info_output_get_result ()

    gboolean
    qmi_message_nas_get_lte_cphy_ca_info_output_get_result
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

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

#### Returns

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

[skip]

Since: 1.16

### qmi_message_nas_get_lte_cphy_ca_info_output_get_dl_bandwidth ()

    gboolean
    qmi_message_nas_get_lte_cphy_ca_info_output_get_dl_bandwidth
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self,
                                    QmiNasDLBandwidth *value_dl_bandwidth,
                                    GError **error);

Get the 'DL Bandwidth' field from `self` .

#### Parameters

self | a QmiMessageNasGetLteCphyCaInfoOutput. |
value_dl_bandwidth | a placeholder for the output QmiNasDLBandwidth, or `NULL` if not required. | [out][optional]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.16

### qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_scell_info ()

    gboolean
    qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_scell_info
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self,
                                    guint16 *value_phy_ca_agg_scell_info_physical_cell_id,
                                    guint16 *value_phy_ca_agg_scell_info_rx_channel,
                                    QmiNasDLBandwidth *value_phy_ca_agg_scell_info_dl_bandwidth,
                                    QmiNasActiveBand *value_phy_ca_agg_scell_info_lte_band,
                                    QmiNasScellState *value_phy_ca_agg_scell_info_state,
                                    GError **error);

Get the 'Phy CA Agg SCell Info' field from `self` .

#### Parameters

self | a QmiMessageNasGetLteCphyCaInfoOutput. |
value_phy_ca_agg_scell_info_physical_cell_id | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_phy_ca_agg_scell_info_rx_channel | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_phy_ca_agg_scell_info_dl_bandwidth | a placeholder for the output QmiNasDLBandwidth, or `NULL` if not required. | [out][optional]
value_phy_ca_agg_scell_info_lte_band | a placeholder for the output QmiNasActiveBand, or `NULL` if not required. | [out][optional]
value_phy_ca_agg_scell_info_state | a placeholder for the output QmiNasScellState, or `NULL` if not required. | [out][optional]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.16

### qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_pcell_info ()

    gboolean
    qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_pcell_info
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self,
                                    guint16 *value_phy_ca_agg_pcell_info_physical_cell_id,
                                    guint16 *value_phy_ca_agg_pcell_info_rx_channel,
                                    QmiNasDLBandwidth *value_phy_ca_agg_pcell_info_dl_bandwidth,
                                    QmiNasActiveBand *value_phy_ca_agg_pcell_info_lte_band,
                                    GError **error);

Get the 'Phy CA Agg PCell Info' field from `self` .

#### Parameters

self | a QmiMessageNasGetLteCphyCaInfoOutput. |
value_phy_ca_agg_pcell_info_physical_cell_id | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_phy_ca_agg_pcell_info_rx_channel | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_phy_ca_agg_pcell_info_dl_bandwidth | a placeholder for the output QmiNasDLBandwidth, or `NULL` if not required. | [out][optional]
value_phy_ca_agg_pcell_info_lte_band | a placeholder for the output QmiNasActiveBand, or `NULL` if not required. | [out][optional]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.16

### qmi_message_nas_get_lte_cphy_ca_info_output_get_scell_index ()

    gboolean
    qmi_message_nas_get_lte_cphy_ca_info_output_get_scell_index
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self,
                                    guint8 *value_scell_index,
                                    GError **error);

Get the 'SCell index' field from `self` .

#### Parameters

self | a QmiMessageNasGetLteCphyCaInfoOutput. |
value_scell_index | a placeholder for the output guint8, or `NULL` if not required. | [out][optional]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.16

### qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_secondary_cells ()

    gboolean
    qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_secondary_cells
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self,
                                    GArray **value_phy_ca_agg_secondary_cells,
                                    GError **error);

Get the 'Phy CA Agg Secondary Cells' field from `self` .

[skip]

#### Parameters

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

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.22

### qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_secondary_cells_gir ()

    gboolean
    qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_secondary_cells_gir
                                   (QmiMessageNasGetLteCphyCaInfoOutput *self,
                                    GPtrArray **value_phy_ca_agg_secondary_cells_ptr,
                                    GError **error);

Get the 'Phy CA Agg Secondary Cells' field from `self` .

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

[rename-to qmi_message_nas_get_lte_cphy_ca_info_output_get_phy_ca_agg_secondary_cells]

#### Parameters

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

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_nas_get_lte_cphy_ca_info_response_parse ()

    QmiMessageNasGetLteCphyCaInfoOutput *
    qmi_message_nas_get_lte_cphy_ca_info_response_parse
                                   (QmiMessage *message,
                                    GError **error);

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

Since: 1.34

### qmi_client_nas_get_lte_cphy_ca_info ()

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

Asynchronously sends a Get LTE Cphy CA Info 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_nas_get_lte_cphy_ca_info_finish()` to get the result of the operation.

#### Parameters

self | a QmiClientNas. |
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.16

### qmi_client_nas_get_lte_cphy_ca_info_finish ()

    QmiMessageNasGetLteCphyCaInfoOutput *
    qmi_client_nas_get_lte_cphy_ca_info_finish
                                   (QmiClientNas *self,
                                    GAsyncResult *res,
                                    GError **error);

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

#### Parameters

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

#### Returns

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

Since: 1.16

## Types and Values

### QmiMessageNasGetLteCphyCaInfoOutput

    typedef struct _QmiMessageNasGetLteCphyCaInfoOutput QmiMessageNasGetLteCphyCaInfoOutput;

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

Since: 1.16

### QmiMessageNasGetLteCphyCaInfoOutputPhyCaAggSecondaryCellsSsc

    typedef struct {
        guint16 physical_cell_id;
        guint16 rx_channel;
        QmiNasDLBandwidth dl_bandwidth;
        QmiNasActiveBand lte_band;
        QmiNasScellState state;
        guint8 cell_index;
    } QmiMessageNasGetLteCphyCaInfoOutputPhyCaAggSecondaryCellsSsc;

A QmiMessageNasGetLteCphyCaInfoOutputPhyCaAggSecondaryCellsSsc struct.

#### Members

guint16 `physical_cell_id`; | a guint16. |
guint16 `rx_channel`; | a guint16. |
QmiNasDLBandwidth `dl_bandwidth`; | a QmiNasDLBandwidth. |
QmiNasActiveBand `lte_band`; | a QmiNasActiveBand. |
QmiNasScellState `state`; | a QmiNasScellState. |
guint8 `cell_index`; | a guint8. |

Since: 1.22