Function tskit::bindings::tsk_provenance_table_get_row[][src]

pub unsafe extern "C" fn tsk_provenance_table_get_row(
    self_: *const tsk_provenance_table_t,
    index: tsk_id_t,
    row: *mut tsk_provenance_t
) -> c_int

@brief Get the row at the specified index.

@rst Updates the specified provenance struct to reflect the values in the specified row. Pointers to memory within this struct are handled by the table and should not be freed by client code. These pointers are guaranteed to be valid until the next operation that modifies the table (e.g., by adding a new row), but not afterwards. @endrst

@param self A pointer to a tsk_provenance_table_t object. @param index The requested table row. @param row A pointer to a tsk_provenance_t struct that is updated to reflect the values in the specified row. @return Return 0 on success or a negative value on failure.