ZL_Data_setIntMetadata

Function ZL_Data_setIntMetadata 

Source
pub unsafe extern "C" fn ZL_Data_setIntMetadata(
    s: *mut ZL_Data,
    mId: c_int,
    mvalue: c_int,
) -> ZL_Report
Expand description

@brief Sets integer metadata with the key @p mId and value @p mvalue on the stream.

It is only valid to call ZL_Data_setIntMetadata() with the same @p mId once. Subsequent calls with the same @p mId will return an error.

@param mId Metdata key @param mvalue Metadata value

@returns Success or an error. This function will fail due to repeated calls with the same @p mId, or upon running out of space for the metadata.

@note In this proposed design, Int Metadata are set one by one. Another possible design could follow the IntParams model, where all parameters must be set all-at-once, and be provided as a single vector of IntParams structures.

@note The set value is an int, hence it’s not suitable to store “large” values, like 64-bit ULL.