ket::c_api::objects

Function ket_process_get_sample

Source 
#[no_mangle]
pub extern "C" fn ket_process_get_sample(
    process: &Process,
    index: usize,
    available: &mut bool,
    result: &mut *const u64,
    count: &mut *const u64,
    size: &mut usize,
) -> i32
Expand description

Retrieves the sample data from the Process instance.

§Arguments

  • process - [in] A reference to the Process instance.
  • index - [in] The index of the sample to query.
  • available - [out] A mutable pointer to a bool indicating if the result is available.
  • result - [out] A mutable pointer to the array of u64 storing the sample data.
  • count - [out] A mutable pointer to the array of u64 storing the sample counts.
  • size - [out] A mutable pointer to the size of the sample data arrays.

§Returns

An integer representing the error code. 0 indicates success.