FOX Get Firmware Version response: libqmi-glib Reference Manual

## FOX Get Firmware Version response FOX Get Firmware Version response — Methods to manage the FOX Get Firmware Version response. |

## Functions

QmiMessageFoxGetFirmwareVersionInput * | qmi_message_fox_get_firmware_version_input_new ()
QmiMessageFoxGetFirmwareVersionInput * | qmi_message_fox_get_firmware_version_input_ref ()
void | qmi_message_fox_get_firmware_version_input_unref ()
gboolean | qmi_message_fox_get_firmware_version_input_get_version_type ()
gboolean | qmi_message_fox_get_firmware_version_input_set_version_type ()
QmiMessageFoxGetFirmwareVersionOutput * | qmi_message_fox_get_firmware_version_output_ref ()
void | qmi_message_fox_get_firmware_version_output_unref ()
gboolean | qmi_message_fox_get_firmware_version_output_get_result ()
gboolean | qmi_message_fox_get_firmware_version_output_get_version ()
QmiMessageFoxGetFirmwareVersionOutput * | qmi_message_fox_get_firmware_version_response_parse ()
void | qmi_client_fox_get_firmware_version ()
QmiMessageFoxGetFirmwareVersionOutput * | qmi_client_fox_get_firmware_version_finish ()

## Types and Values

| QmiMessageFoxGetFirmwareVersionInput
| QmiMessageFoxGetFirmwareVersionOutput

## Object Hierarchy

        GBoxed
        ├── QmiMessageFoxGetFirmwareVersionInput
        ╰── QmiMessageFoxGetFirmwareVersionOutput

## Description

Collection of methods to create requests and parse responses of the FOX Get Firmware Version message.

## Functions

### qmi_message_fox_get_firmware_version_input_new ()

    QmiMessageFoxGetFirmwareVersionInput *
    qmi_message_fox_get_firmware_version_input_new
                                   (void);

Allocates a new QmiMessageFoxGetFirmwareVersionInput.

#### Returns

the newly created QmiMessageFoxGetFirmwareVersionInput. The returned value should be freed with `qmi_message_fox_get_firmware_version_input_unref()`.

Since: 1.32

### qmi_message_fox_get_firmware_version_input_ref ()

    QmiMessageFoxGetFirmwareVersionInput *
    qmi_message_fox_get_firmware_version_input_ref
                                   (QmiMessageFoxGetFirmwareVersionInput *self);

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

#### Parameters

self | a QmiMessageFoxGetFirmwareVersionInput. |

#### Returns

the new reference to `self` .

Since: 1.32

### qmi_message_fox_get_firmware_version_input_unref ()

    void
    qmi_message_fox_get_firmware_version_input_unref
                                   (QmiMessageFoxGetFirmwareVersionInput *self);

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

#### Parameters

self | a QmiMessageFoxGetFirmwareVersionInput. |

Since: 1.32

### qmi_message_fox_get_firmware_version_input_get_version_type ()

    gboolean
    qmi_message_fox_get_firmware_version_input_get_version_type
                                   (QmiMessageFoxGetFirmwareVersionInput *self,
                                    QmiFoxFirmwareVersionType *value_version_type,
                                    GError **error);

Get the 'Version Type' field from `self` .

#### Parameters

self | a QmiMessageFoxGetFirmwareVersionInput. |
value_version_type | a placeholder for the output QmiFoxFirmwareVersionType, 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.32

### qmi_message_fox_get_firmware_version_input_set_version_type ()

    gboolean
    qmi_message_fox_get_firmware_version_input_set_version_type
                                   (QmiMessageFoxGetFirmwareVersionInput *self,
                                    QmiFoxFirmwareVersionType value_version_type,
                                    GError **error);

Set the 'Version Type' field in the message.

#### Parameters

self | a QmiMessageFoxGetFirmwareVersionInput. |
value_version_type | a QmiFoxFirmwareVersionType. |
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if `value` was successfully set, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_fox_get_firmware_version_output_ref ()

    QmiMessageFoxGetFirmwareVersionOutput *
    qmi_message_fox_get_firmware_version_output_ref
                                   (QmiMessageFoxGetFirmwareVersionOutput *self);

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

#### Parameters

self | a QmiMessageFoxGetFirmwareVersionOutput. |

#### Returns

the new reference to `self` .

Since: 1.32

### qmi_message_fox_get_firmware_version_output_unref ()

    void
    qmi_message_fox_get_firmware_version_output_unref
                                   (QmiMessageFoxGetFirmwareVersionOutput *self);

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

#### Parameters

self | a QmiMessageFoxGetFirmwareVersionOutput. |

Since: 1.32

### qmi_message_fox_get_firmware_version_output_get_result ()

    gboolean
    qmi_message_fox_get_firmware_version_output_get_result
                                   (QmiMessageFoxGetFirmwareVersionOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

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

#### Returns

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

[skip]

Since: 1.32

### qmi_message_fox_get_firmware_version_output_get_version ()

    gboolean
    qmi_message_fox_get_firmware_version_output_get_version
                                   (QmiMessageFoxGetFirmwareVersionOutput *self,
                                    const gchar **value_version,
                                    GError **error);

Get the 'Version' field from `self` .

#### Parameters

self | a QmiMessageFoxGetFirmwareVersionOutput. |
value_version | a placeholder for the output constant string, or `NULL` if not required. | [out][optional][transfer none]
error | Return location for error or `NULL`. |

#### Returns

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

[skip]

Since: 1.32

### qmi_message_fox_get_firmware_version_response_parse ()

    QmiMessageFoxGetFirmwareVersionOutput *
    qmi_message_fox_get_firmware_version_response_parse
                                   (QmiMessage *message,
                                    GError **error);

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

Since: 1.34

### qmi_client_fox_get_firmware_version ()

    void
    qmi_client_fox_get_firmware_version (QmiClientFox *self,
                                         QmiMessageFoxGetFirmwareVersionInput *input,
                                         guint timeout,
                                         GCancellable *cancellable,
                                         GAsyncReadyCallback callback,
                                         gpointer user_data);

Asynchronously sends a Get Firmware Version 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_fox_get_firmware_version_finish()` to get the result of the operation.

#### Parameters

self | a QmiClientFox. |
input | a QmiMessageFoxGetFirmwareVersionInput. |
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.32

### qmi_client_fox_get_firmware_version_finish ()

    QmiMessageFoxGetFirmwareVersionOutput *
    qmi_client_fox_get_firmware_version_finish
                                   (QmiClientFox *self,
                                    GAsyncResult *res,
                                    GError **error);

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

#### Parameters

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

#### Returns

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

Since: 1.32

## Types and Values

### QmiMessageFoxGetFirmwareVersionInput

    typedef struct _QmiMessageFoxGetFirmwareVersionInput QmiMessageFoxGetFirmwareVersionInput;

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

Since: 1.32

### QmiMessageFoxGetFirmwareVersionOutput

    typedef struct _QmiMessageFoxGetFirmwareVersionOutput QmiMessageFoxGetFirmwareVersionOutput;

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

Since: 1.32