ohos-rdb-sys 0.1.0

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::rdb_types::{Data_Asset, OH_ColumnType, OH_Data_Value};

extern "C" {
    /// Creates an OH_Data_Value instance object.
    ///
    ///
    /// # Returns
    ///
    /// * Returns a pointer to OH_Data_Value instance when the execution is successful.
    /// Otherwise, nullptr is returned. The memory must be released through the OH_Value_Destroy
    /// interface after the use is complete.
    /// [`OH_Value_Destroy.`]
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_Create() -> *mut OH_Data_Value;
    /// Destroys an OH_Data_Value instance object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_Destroy(value: *mut OH_Data_Value) -> ::core::ffi::c_int;
    /// Set empty data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutNull(value: *mut OH_Data_Value) -> ::core::ffi::c_int;
    /// Set integer data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a integer data.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutInt(value: *mut OH_Data_Value, val: i64) -> ::core::ffi::c_int;
    /// Set decimal data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a decimal data.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutReal(value: *mut OH_Data_Value, val: f64) -> ::core::ffi::c_int;
    /// Set string data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a string data.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutText(
        value: *mut OH_Data_Value,
        val: *const ::core::ffi::c_char,
    ) -> ::core::ffi::c_int;
    /// Set binary data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a binary data.
    ///
    /// * `length` - Represents the size of binary data.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutBlob(
        value: *mut OH_Data_Value,
        val: *const ::core::ffi::c_uchar,
        length: usize,
    ) -> ::core::ffi::c_int;
    /// Set Data_Asset data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to an instance of Data_Asset.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutAsset(
        value: *mut OH_Data_Value,
        val: *const Data_Asset,
    ) -> ::core::ffi::c_int;
    /// Set multiple Data_Asset data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to multiple Data_Asset.
    ///
    /// * `length` - Represents the count of multiple data.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutAssets(
        value: *mut OH_Data_Value,
        val: *const *const Data_Asset,
        length: usize,
    ) -> ::core::ffi::c_int;
    /// Set float array data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to float array.
    ///
    /// * `length` - Represents the size of float array.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutFloatVector(
        value: *mut OH_Data_Value,
        val: *const f32,
        length: usize,
    ) -> ::core::ffi::c_int;
    /// Set an integer of any length data to the OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `sign` - Represents 0 is positive integer, 1 is negative integer.
    ///
    /// * `trueForm` - Represents a pointer to integer array.
    ///
    /// * `length` - Represents the size of integer array.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_PutUnlimitedInt(
        value: *mut OH_Data_Value,
        sign: ::core::ffi::c_int,
        trueForm: *const u64,
        length: usize,
    ) -> ::core::ffi::c_int;
    /// Get data type from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `type` - Represents the parameter of the data type. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetType(
        value: *mut OH_Data_Value,
        type_: *mut OH_ColumnType,
    ) -> ::core::ffi::c_int;
    /// Check whether the data is empty from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents empty data flag. It is an output parameter.
    /// The value true means that the data is empty, and false means the opposite.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_IsNull(value: *mut OH_Data_Value, val: *mut bool) -> ::core::ffi::c_int;
    /// Get integer data from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to an integer data. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetInt(value: *mut OH_Data_Value, val: *mut i64) -> ::core::ffi::c_int;
    /// Get decimal data from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to an decimal data. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetReal(value: *mut OH_Data_Value, val: *mut f64) -> ::core::ffi::c_int;
    /// Get string data from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to a string data. It is an output parameter.
    /// The caller does not need to apply for memory and release memory. The life cycle of val follows value.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetText(
        value: *mut OH_Data_Value,
        val: *mut *const ::core::ffi::c_char,
    ) -> ::core::ffi::c_int;
    /// Get binary data from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to a binary data. It is an output parameter.
    /// The caller does not need to apply for memory and release memory. The life cycle of val follows value.
    ///
    /// * `length` - Represents the size of binary array.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetBlob(
        value: *mut OH_Data_Value,
        val: *mut *const u8,
        length: *mut usize,
    ) -> ::core::ffi::c_int;
    /// Get Data_Asset data from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to an instance of Data_Asset. The caller needs to apply for data memory.
    /// This function only fills data. Otherwise, the execution fails.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetAsset(value: *mut OH_Data_Value, val: *mut Data_Asset)
        -> ::core::ffi::c_int;
    /// Get multiple Data_Asset size from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `length` - Represents the size of Data_Asset array. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetAssetsCount(
        value: *mut OH_Data_Value,
        length: *mut usize,
    ) -> ::core::ffi::c_int;
    /// Get multiple Data_Asset data from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to Data_Asset array. The caller needs to apply for data memory.
    /// This function only fills data. Otherwise, the execution fails.
    ///
    /// * `inLen` - Represents the size of val. It can be obtained through the OH_Value_GetAssetsCount function.
    ///
    /// * `outLen` - Represents the actual amount of data obtained. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    /// [`OH_Value_GetAssetsCount.`]
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetAssets(
        value: *mut OH_Data_Value,
        val: *mut *mut Data_Asset,
        inLen: usize,
        outLen: *mut usize,
    ) -> ::core::ffi::c_int;
    /// Get float array data size from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `length` - Represents the size of float array. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetFloatVectorCount(
        value: *mut OH_Data_Value,
        length: *mut usize,
    ) -> ::core::ffi::c_int;
    /// Get float array from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `val` - Represents a pointer to float array. The caller needs to apply for data memory.
    /// This function only fills data. Otherwise, the execution fails.
    ///
    /// * `inLen` - Represents the size of val. It can be obtained through the OH_Value_GetFloatVectorCount function.
    ///
    /// * `outLen` - Represents the actual amount of data obtained. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    /// [`OH_Value_GetFloatVectorCount.`]
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetFloatVector(
        value: *mut OH_Data_Value,
        val: *mut f32,
        inLen: usize,
        outLen: *mut usize,
    ) -> ::core::ffi::c_int;
    /// Get an integer of any length data size from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `length` - Represents the size of integer array. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetUnlimitedIntBand(
        value: *mut OH_Data_Value,
        length: *mut usize,
    ) -> ::core::ffi::c_int;
    /// Get an integer of any length data from OH_Data_Value object.
    ///
    /// # Arguments
    ///
    /// * `value` - Represents a pointer to an instance of OH_Data_Value.
    ///
    /// * `sign` - Represents 0 is positive integer, 1 is negative integer. It is an output parameter.
    ///
    /// * `trueForm` - Represents a pointer to integer array. The caller needs to apply for data memory.
    /// This function only fills data. Otherwise, the execution fails.
    ///
    /// * `inLen` - Represents the size of trueForm. It can be obtained through the OH_Value_GetUnlimitedIntBand function.
    ///
    /// * `outLen` - Represents the actual amount of data obtained. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_DATA_TYPE_NULL`] the content stored in parameter value is null.
    /// Returns [`RDB_E_TYPE_MISMATCH`] storage data type mismatch.
    /// [`OH_Value_GetUnlimitedIntBand.`]
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Value_GetUnlimitedInt(
        value: *mut OH_Data_Value,
        sign: *mut ::core::ffi::c_int,
        trueForm: *mut u64,
        inLen: usize,
        outLen: *mut usize,
    ) -> ::core::ffi::c_int;
}