NAS Get Preferred Networks response: libqmi-glib Reference Manual

## NAS Get Preferred Networks response NAS Get Preferred Networks response — Methods to manage the NAS Get Preferred Networks response. |

## Functions

QmiMessageNasGetPreferredNetworksOutput * | qmi_message_nas_get_preferred_networks_output_ref ()
void | qmi_message_nas_get_preferred_networks_output_unref ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_static_mnc_pcs_digit_include_status ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_static_mnc_pcs_digit_include_status_gir ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_result ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_preferred_networks ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_preferred_networks_gir ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_static_preferred_networks ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_static_preferred_networks_gir ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_mnc_pcs_digit_include_status ()
gboolean | qmi_message_nas_get_preferred_networks_output_get_mnc_pcs_digit_include_status_gir ()
QmiMessageNasGetPreferredNetworksOutput * | qmi_message_nas_get_preferred_networks_response_parse ()
void | qmi_client_nas_get_preferred_networks ()
QmiMessageNasGetPreferredNetworksOutput * | qmi_client_nas_get_preferred_networks_finish ()

## Types and Values

| QmiMessageNasGetPreferredNetworksOutput
| QmiMessageNasGetPreferredNetworksOutputStaticMncPcsDigitIncludeStatusElement
| QmiMessageNasGetPreferredNetworksOutputPreferredNetworksElement
| QmiMessageNasGetPreferredNetworksOutputStaticPreferredNetworksElement
| QmiMessageNasGetPreferredNetworksOutputMncPcsDigitIncludeStatusElement

## Object Hierarchy

        GBoxed
        ├── QmiMessageNasGetPreferredNetworksOutput
        ├── QmiMessageNasGetPreferredNetworksOutputMncPcsDigitIncludeStatusElement
        ├── QmiMessageNasGetPreferredNetworksOutputPreferredNetworksElement
        ├── QmiMessageNasGetPreferredNetworksOutputStaticMncPcsDigitIncludeStatusElement
        ╰── QmiMessageNasGetPreferredNetworksOutputStaticPreferredNetworksElement

## Description

Collection of methods to create requests and parse responses of the NAS Get Preferred Networks message.

## Functions

### qmi_message_nas_get_preferred_networks_output_ref ()

    QmiMessageNasGetPreferredNetworksOutput *
    qmi_message_nas_get_preferred_networks_output_ref
                                   (QmiMessageNasGetPreferredNetworksOutput *self);

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

#### Parameters

self | a QmiMessageNasGetPreferredNetworksOutput. |

#### Returns

the new reference to `self` .

Since: 1.30

### qmi_message_nas_get_preferred_networks_output_unref ()

    void
    qmi_message_nas_get_preferred_networks_output_unref
                                   (QmiMessageNasGetPreferredNetworksOutput *self);

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

#### Parameters

self | a QmiMessageNasGetPreferredNetworksOutput. |

Since: 1.30

### qmi_message_nas_get_preferred_networks_output_get_static_mnc_pcs_digit_include_status ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_static_mnc_pcs_digit_include_status
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GArray **value_static_mnc_pcs_digit_include_status,
                                    GError **error);

Get the 'Static MNC PCS Digit Include Status' field from `self` .

[skip]

#### Parameters

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

#### Returns

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

[skip]

Since: 1.36

### qmi_message_nas_get_preferred_networks_output_get_static_mnc_pcs_digit_include_status_gir ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_static_mnc_pcs_digit_include_status_gir
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GPtrArray **value_static_mnc_pcs_digit_include_status_ptr,
                                    GError **error);

Get the 'Static MNC PCS Digit Include Status' field from `self` .

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

[rename-to qmi_message_nas_get_preferred_networks_output_get_static_mnc_pcs_digit_include_status]

#### Parameters

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

#### Returns

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

[skip]

Since: 1.36

### qmi_message_nas_get_preferred_networks_output_get_result ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_result
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

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

#### Returns

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

[skip]

Since: 1.30

### qmi_message_nas_get_preferred_networks_output_get_preferred_networks ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_preferred_networks
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GArray **value_preferred_networks,
                                    GError **error);

Get the 'Preferred Networks' field from `self` .

[skip]

#### Parameters

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

#### Returns

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

[skip]

Since: 1.30

### qmi_message_nas_get_preferred_networks_output_get_preferred_networks_gir ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_preferred_networks_gir
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GPtrArray **value_preferred_networks_ptr,
                                    GError **error);

Get the 'Preferred Networks' field from `self` .

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

[rename-to qmi_message_nas_get_preferred_networks_output_get_preferred_networks]

#### Parameters

self | a QmiMessageNasGetPreferredNetworksOutput. |
value_preferred_networks_ptr | a placeholder for the output array of QmiMessageNasGetPreferredNetworksOutputPreferredNetworksElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` . | [out][optional][element-type QmiMessageNasGetPreferredNetworksOutputPreferredNetworksElement][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_preferred_networks_output_get_static_preferred_networks ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_static_preferred_networks
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GArray **value_static_preferred_networks,
                                    GError **error);

Get the 'Static Preferred Networks' field from `self` .

[skip]

#### Parameters

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

#### Returns

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

[skip]

Since: 1.36

### qmi_message_nas_get_preferred_networks_output_get_static_preferred_networks_gir ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_static_preferred_networks_gir
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GPtrArray **value_static_preferred_networks_ptr,
                                    GError **error);

Get the 'Static Preferred Networks' field from `self` .

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

[rename-to qmi_message_nas_get_preferred_networks_output_get_static_preferred_networks]

#### Parameters

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

#### Returns

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

[skip]

Since: 1.36

### qmi_message_nas_get_preferred_networks_output_get_mnc_pcs_digit_include_status ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_mnc_pcs_digit_include_status
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GArray **value_mnc_pcs_digit_include_status,
                                    GError **error);

Get the 'MNC PCS Digit Include Status' field from `self` .

[skip]

#### Parameters

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

#### Returns

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

[skip]

Since: 1.30

### qmi_message_nas_get_preferred_networks_output_get_mnc_pcs_digit_include_status_gir ()

    gboolean
    qmi_message_nas_get_preferred_networks_output_get_mnc_pcs_digit_include_status_gir
                                   (QmiMessageNasGetPreferredNetworksOutput *self,
                                    GPtrArray **value_mnc_pcs_digit_include_status_ptr,
                                    GError **error);

Get the 'MNC PCS Digit Include Status' field from `self` .

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

[rename-to qmi_message_nas_get_preferred_networks_output_get_mnc_pcs_digit_include_status]

#### Parameters

self | a QmiMessageNasGetPreferredNetworksOutput. |
value_mnc_pcs_digit_include_status_ptr | a placeholder for the output array of QmiMessageNasGetPreferredNetworksOutputMncPcsDigitIncludeStatusElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` . | [out][optional][element-type QmiMessageNasGetPreferredNetworksOutputMncPcsDigitIncludeStatusElement][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_preferred_networks_response_parse ()

    QmiMessageNasGetPreferredNetworksOutput *
    qmi_message_nas_get_preferred_networks_response_parse
                                   (QmiMessage *message,
                                    GError **error);

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

Since: 1.34

### qmi_client_nas_get_preferred_networks ()

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

Asynchronously sends a Get Preferred Networks 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_preferred_networks_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.30

### qmi_client_nas_get_preferred_networks_finish ()

    QmiMessageNasGetPreferredNetworksOutput *
    qmi_client_nas_get_preferred_networks_finish
                                   (QmiClientNas *self,
                                    GAsyncResult *res,
                                    GError **error);

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

#### Parameters

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

#### Returns

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

Since: 1.30

## Types and Values

### QmiMessageNasGetPreferredNetworksOutput

    typedef struct _QmiMessageNasGetPreferredNetworksOutput QmiMessageNasGetPreferredNetworksOutput;

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

Since: 1.30

### QmiMessageNasGetPreferredNetworksOutputStaticMncPcsDigitIncludeStatusElement

    typedef struct {
        guint16 mcc;
        guint16 mnc;
        gboolean includes_pcs_digit;
    } QmiMessageNasGetPreferredNetworksOutputStaticMncPcsDigitIncludeStatusElement;

A QmiMessageNasGetPreferredNetworksOutputStaticMncPcsDigitIncludeStatusElement struct.

#### Members

guint16 `mcc`; | a guint16. |
guint16 `mnc`; | a guint16. |
gboolean `includes_pcs_digit`; | a gboolean. |

Since: 1.36

### QmiMessageNasGetPreferredNetworksOutputPreferredNetworksElement

    typedef struct {
        guint16 mcc;
        guint16 mnc;
        QmiNasPlmnAccessTechnologyIdentifier radio_access_technology;
    } QmiMessageNasGetPreferredNetworksOutputPreferredNetworksElement;

A QmiMessageNasGetPreferredNetworksOutputPreferredNetworksElement struct.

#### Members

guint16 `mcc`; | a guint16. |
guint16 `mnc`; | a guint16. |
QmiNasPlmnAccessTechnologyIdentifier `radio_access_technology`; | a QmiNasPlmnAccessTechnologyIdentifier. |

Since: 1.30

### QmiMessageNasGetPreferredNetworksOutputStaticPreferredNetworksElement

    typedef struct {
        guint16 mcc;
        guint16 mnc;
        QmiNasPlmnAccessTechnologyIdentifier radio_access_technology;
    } QmiMessageNasGetPreferredNetworksOutputStaticPreferredNetworksElement;

A QmiMessageNasGetPreferredNetworksOutputStaticPreferredNetworksElement struct.

#### Members

guint16 `mcc`; | a guint16. |
guint16 `mnc`; | a guint16. |
QmiNasPlmnAccessTechnologyIdentifier `radio_access_technology`; | a QmiNasPlmnAccessTechnologyIdentifier. |

Since: 1.36

### QmiMessageNasGetPreferredNetworksOutputMncPcsDigitIncludeStatusElement

    typedef struct {
        guint16 mcc;
        guint16 mnc;
        gboolean includes_pcs_digit;
    } QmiMessageNasGetPreferredNetworksOutputMncPcsDigitIncludeStatusElement;

A QmiMessageNasGetPreferredNetworksOutputMncPcsDigitIncludeStatusElement struct.

#### Members

guint16 `mcc`; | a guint16. |
guint16 `mnc`; | a guint16. |
gboolean `includes_pcs_digit`; | a gboolean. |

Since: 1.30