Function tskit::bindings::tsk_site_table_get_row

pub unsafe extern "C" fn tsk_site_table_get_row(
    self_: *const tsk_site_table_t,
    index: tsk_id_t,
    row: *mut tsk_site_t
) -> c_int

@brief Get the row at the specified index.

@rst Updates the specified site struct to reflect the values in the specified row.

This function always sets the mutations and mutations_length fields in the parameter :c:struct:tsk_site_t to NULL and 0 respectively. To get access to the mutations for a particular site, please use the tree sequence method, :c:func:tsk_treeseq_get_site.

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_site_table_t object. @param index The requested table row. @param row A pointer to a tsk_site_t struct that is updated to reflect the values in the specified row. @return Return 0 on success or a negative value on failure.