DMS Read User Data response: libqmi-glib Reference Manual

## DMS Read User Data response DMS Read User Data response — Methods to manage the DMS Read User Data response. |

## Functions

QmiMessageDmsReadUserDataOutput * | qmi_message_dms_read_user_data_output_ref ()
void | qmi_message_dms_read_user_data_output_unref ()
gboolean | qmi_message_dms_read_user_data_output_get_result ()
gboolean | qmi_message_dms_read_user_data_output_get_user_data ()
void | qmi_client_dms_read_user_data ()
QmiMessageDmsReadUserDataOutput * | qmi_client_dms_read_user_data_finish ()

## Types and Values

| QmiMessageDmsReadUserDataOutput

## Object Hierarchy

        GBoxed
        ╰── QmiMessageDmsReadUserDataOutput

## Description

Collection of methods to create requests and parse responses of the DMS Read User Data message.

## Functions

### qmi_message_dms_read_user_data_output_ref ()

    QmiMessageDmsReadUserDataOutput *
    qmi_message_dms_read_user_data_output_ref
                                   (QmiMessageDmsReadUserDataOutput *self);

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

#### Parameters

self | a QmiMessageDmsReadUserDataOutput. |

#### Returns

the new reference to `self` .

Since: 1.0

### qmi_message_dms_read_user_data_output_unref ()

    void
    qmi_message_dms_read_user_data_output_unref
                                   (QmiMessageDmsReadUserDataOutput *self);

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

#### Parameters

self | a QmiMessageDmsReadUserDataOutput. |

Since: 1.0

### qmi_message_dms_read_user_data_output_get_result ()

    gboolean
    qmi_message_dms_read_user_data_output_get_result
                                   (QmiMessageDmsReadUserDataOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

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

#### Returns

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

[skip]

Since: 1.0

### qmi_message_dms_read_user_data_output_get_user_data ()

    gboolean
    qmi_message_dms_read_user_data_output_get_user_data
                                   (QmiMessageDmsReadUserDataOutput *self,
                                    GArray **value_user_data,
                                    GError **error);

Get the 'User Data' field from `self` .

#### Parameters

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

#### Returns

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

[skip]

Since: 1.0

### qmi_client_dms_read_user_data ()

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

Asynchronously sends a Read User Data 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_dms_read_user_data_finish()` to get the result of the operation.

#### Parameters

self | a QmiClientDms. |
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.0

### qmi_client_dms_read_user_data_finish ()

    QmiMessageDmsReadUserDataOutput *
    qmi_client_dms_read_user_data_finish (QmiClientDms *self,
                                          GAsyncResult *res,
                                          GError **error);

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

#### Parameters

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

#### Returns

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

Since: 1.0

## Types and Values

### QmiMessageDmsReadUserDataOutput

    typedef struct _QmiMessageDmsReadUserDataOutput QmiMessageDmsReadUserDataOutput;

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

Since: 1.0