UIM Get Card Status response: libqmi-glib Reference Manual

## UIM Get Card Status response UIM Get Card Status response — Methods to manage the UIM Get Card Status response. |

## Functions

QmiMessageUimGetCardStatusOutput * | qmi_message_uim_get_card_status_output_ref ()
void | qmi_message_uim_get_card_status_output_unref ()
gboolean | qmi_message_uim_get_card_status_output_get_card_status ()
gboolean | qmi_message_uim_get_card_status_output_get_card_status_gir ()
gboolean | qmi_message_uim_get_card_status_output_get_result ()
QmiMessageUimGetCardStatusOutput * | qmi_message_uim_get_card_status_response_parse ()
void | qmi_client_uim_get_card_status ()
QmiMessageUimGetCardStatusOutput * | qmi_client_uim_get_card_status_finish ()

## Types and Values

| QmiMessageUimGetCardStatusOutput
| QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2
| QmiMessageUimGetCardStatusOutputCardStatusCardsElement
| QmiMessageUimGetCardStatusOutputCardStatusCardsElementGir

## Object Hierarchy

        GBoxed
        ├── QmiMessageUimGetCardStatusOutput
        ├── QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2
        ╰── QmiMessageUimGetCardStatusOutputCardStatusCardsElementGir

## Description

Collection of methods to create requests and parse responses of the UIM Get Card Status message.

## Functions

### qmi_message_uim_get_card_status_output_ref ()

    QmiMessageUimGetCardStatusOutput *
    qmi_message_uim_get_card_status_output_ref
                                   (QmiMessageUimGetCardStatusOutput *self);

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

#### Parameters

self | a QmiMessageUimGetCardStatusOutput. |

#### Returns

the new reference to `self` .

Since: 1.10

### qmi_message_uim_get_card_status_output_unref ()

    void
    qmi_message_uim_get_card_status_output_unref
                                   (QmiMessageUimGetCardStatusOutput *self);

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

#### Parameters

self | a QmiMessageUimGetCardStatusOutput. |

Since: 1.10

### qmi_message_uim_get_card_status_output_get_card_status ()

    gboolean
    qmi_message_uim_get_card_status_output_get_card_status
                                   (QmiMessageUimGetCardStatusOutput *self,
                                    guint16 *value_card_status_index_gw_primary,
                                    guint16 *value_card_status_index_1x_primary,
                                    guint16 *value_card_status_index_gw_secondary,
                                    guint16 *value_card_status_index_1x_secondary,
                                    GArray **value_card_status_cards,
                                    GError **error);

Get the 'Card Status' field from `self` .

[skip]

#### Parameters

self | a QmiMessageUimGetCardStatusOutput. |
value_card_status_index_gw_primary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_index_1x_primary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_index_gw_secondary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_index_1x_secondary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_cards | a placeholder for the output GArray of QmiMessageUimGetCardStatusOutputCardStatusCardsElement elements, or `NULL` if not required. Do not free it, it is owned by `self` . | [out][optional][element-type QmiMessageUimGetCardStatusOutputCardStatusCardsElement][transfer none]
error | Return location for error or `NULL`. |

#### Returns

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

[skip]

Since: 1.10

### qmi_message_uim_get_card_status_output_get_card_status_gir ()

    gboolean
    qmi_message_uim_get_card_status_output_get_card_status_gir
                                   (QmiMessageUimGetCardStatusOutput *self,
                                    guint16 *value_card_status_index_gw_primary,
                                    guint16 *value_card_status_index_1x_primary,
                                    guint16 *value_card_status_index_gw_secondary,
                                    guint16 *value_card_status_index_1x_secondary,
                                    GPtrArray **value_card_status_cards_ptr,
                                    GError **error);

Get the 'Card Status' field from `self` .

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

[rename-to qmi_message_uim_get_card_status_output_get_card_status]

#### Parameters

self | a QmiMessageUimGetCardStatusOutput. |
value_card_status_index_gw_primary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_index_1x_primary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_index_gw_secondary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_index_1x_secondary | a placeholder for the output guint16, or `NULL` if not required. | [out][optional]
value_card_status_cards_ptr | a placeholder for the output array of QmiMessageUimGetCardStatusOutputCardStatusCardsElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` . | [out][optional][element-type QmiMessageUimGetCardStatusOutputCardStatusCardsElementGir][transfer none]
error | Return location for error or `NULL`. |

#### Returns

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

[skip]

Since: 1.32

### qmi_message_uim_get_card_status_output_get_result ()

    gboolean
    qmi_message_uim_get_card_status_output_get_result
                                   (QmiMessageUimGetCardStatusOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

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

#### Returns

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

[skip]

Since: 1.10

### qmi_message_uim_get_card_status_response_parse ()

    QmiMessageUimGetCardStatusOutput *
    qmi_message_uim_get_card_status_response_parse
                                   (QmiMessage *message,
                                    GError **error);

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

Since: 1.34

### qmi_client_uim_get_card_status ()

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

Asynchronously sends a Get Card Status 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_uim_get_card_status_finish()` to get the result of the operation.

#### Parameters

self | a QmiClientUim. |
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.10

### qmi_client_uim_get_card_status_finish ()

    QmiMessageUimGetCardStatusOutput *
    qmi_client_uim_get_card_status_finish (QmiClientUim *self,
                                           GAsyncResult *res,
                                           GError **error);

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

#### Parameters

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

#### Returns

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

Since: 1.10

## Types and Values

### QmiMessageUimGetCardStatusOutput

    typedef struct _QmiMessageUimGetCardStatusOutput QmiMessageUimGetCardStatusOutput;

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

Since: 1.10

### QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2

    typedef struct {
        QmiUimCardApplicationType type;
        QmiUimCardApplicationState state;
        QmiUimCardApplicationPersonalizationState personalization_state;
        QmiUimCardApplicationPersonalizationFeatureStatus personalization_feature;
        guint8 personalization_retries;
        guint8 personalization_unblock_retries;
        GArray *application_identifier_value;
        gboolean upin_replaces_pin1;
        QmiUimPinState pin1_state;
        guint8 pin1_retries;
        guint8 puk1_retries;
        QmiUimPinState pin2_state;
        guint8 pin2_retries;
        guint8 puk2_retries;
    } QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2;

A QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2 struct.

#### Members

QmiUimCardApplicationType `type`; | a QmiUimCardApplicationType. |
QmiUimCardApplicationState `state`; | a QmiUimCardApplicationState. |
QmiUimCardApplicationPersonalizationState `personalization_state`; | a QmiUimCardApplicationPersonalizationState. |
QmiUimCardApplicationPersonalizationFeatureStatus `personalization_feature`; | a QmiUimCardApplicationPersonalizationFeatureStatus. |
guint8 `personalization_retries`; | a guint8. |
guint8 `personalization_unblock_retries`; | a guint8. |
GArray *`application_identifier_value`; | a GArray of guint8 elements. |
gboolean `upin_replaces_pin1`; | a gboolean. |
QmiUimPinState `pin1_state`; | a QmiUimPinState. |
guint8 `pin1_retries`; | a guint8. |
guint8 `puk1_retries`; | a guint8. |
QmiUimPinState `pin2_state`; | a QmiUimPinState. |
guint8 `pin2_retries`; | a guint8. |
guint8 `puk2_retries`; | a guint8. |

Since: 1.34

### QmiMessageUimGetCardStatusOutputCardStatusCardsElement

    typedef struct {
        QmiUimCardState card_state;
        QmiUimPinState upin_state;
        guint8 upin_retries;
        guint8 upuk_retries;
        QmiUimCardError error_code;
        GArray *applications;
    } QmiMessageUimGetCardStatusOutputCardStatusCardsElement;

A QmiMessageUimGetCardStatusOutputCardStatusCardsElement struct.

#### Members

QmiUimCardState `card_state`; | a QmiUimCardState. |
QmiUimPinState `upin_state`; | a QmiUimPinState. |
guint8 `upin_retries`; | a guint8. |
guint8 `upuk_retries`; | a guint8. |
QmiUimCardError `error_code`; | a QmiUimCardError. |
GArray *`applications`; | a GArray of QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2 elements. |

Since: 1.10

### QmiMessageUimGetCardStatusOutputCardStatusCardsElementGir

    typedef struct {
        QmiUimCardState card_state;
        QmiUimPinState upin_state;
        guint8 upin_retries;
        guint8 upuk_retries;
        QmiUimCardError error_code;
        GPtrArray *applications;
    } QmiMessageUimGetCardStatusOutputCardStatusCardsElementGir;

A QmiMessageUimGetCardStatusOutputCardStatusCardsElementGir struct.

This type is a version of QmiMessageUimGetCardStatusOutputCardStatusCardsElement, using arrays of pointers to structs instead of arrays of structs, for easier binding in other languages.

#### Members

QmiUimCardState `card_state`; | a QmiUimCardState. |
QmiUimPinState `upin_state`; | a QmiUimPinState. |
guint8 `upin_retries`; | a guint8. |
guint8 `upuk_retries`; | a guint8. |
QmiUimCardError `error_code`; | a QmiUimCardError. |
GPtrArray *`applications`; | an array of QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2 elements. | [element-type QmiMessageUimGetCardStatusOutputCardStatusCardsElementApplicationsElementV2]

Since: 1.32