sam_index_load3

@param fp File handle of the data file whose index is being opened @param fn BAM/CRAM/etc data file filename @param fnidx Index filename, or NULL to search alongside @a fn @param flags Flags to alter behaviour (see description) @return The index, or NULL if an error occurred.

The @p flags parameter can be set to a combination of the following values:

HTS_IDX_SAVE_REMOTE Save a local copy of any remote indexes HTS_IDX_SILENT_FAIL Fail silently if the index is not present

Note that HTS_IDX_SAVE_REMOTE has no effect for remote CRAM indexes. They are always downloaded and never cached locally.

The index struct returned by a successful call should be freed via hts_idx_destroy() when it is no longer needed.

extern (C)
sam_index_load3
(,
const(char)* fn
,
const(char)* fnidx
,
int flags
)

Meta