NAME¶

libfcache.h — Library to provide generic file data cache functions

SYNOPSIS¶

#include <libfcache.h>

Support functions
const char *
libfcache_get_version(void);

Error functions
void
libfcache_error_free(libfcache_error_t **error);

int
libfcache_error_fprint(libfcache_error_t *error, FILE *stream);

int
libfcache_error_sprint(libfcache_error_t *error, char *string, size_t size);

int
libfcache_error_backtrace_fprint(libfcache_error_t *error, FILE *stream);

int
libfcache_error_backtrace_sprint(libfcache_error_t *error, char *string, size_t size);

Cache functions
int
libfcache_cache_initialize(libfcache_cache_t **cache, int maximum_cache_entries, libfcache_error_t **error);

int
libfcache_cache_free(libfcache_cache_t **cache, libfcache_error_t **error);

int
libfcache_cache_empty(libfcache_cache_t *cache, libfcache_error_t **error);

int
libfcache_cache_clone(libfcache_cache_t **destination_cache, libfcache_cache_t *source_cache, libfcache_error_t **error);

int
libfcache_cache_get_number_of_entries(libfcache_cache_t *cache, int *number_of_entries, libfcache_error_t **error);

int
libfcache_cache_get_number_of_cache_values(libfcache_cache_t *cache, int *number_of_values, libfcache_error_t **error);

int
libfcache_cache_clear_value_by_index(libfcache_cache_t *cache, int cache_entry_index, libfcache_error_t **error);

int
libfcache_cache_get_value_by_identifier(libfcache_cache_t *cache, int file_index, off64_t offset, int64_t timestamp, libfcache_cache_value_t **cache_value, libfcache_error_t **error);

int
libfcache_cache_get_value_by_index(libfcache_cache_t *cache, int cache_entry_index, libfcache_cache_value_t **cache_value, libfcache_error_t **error);

int
libfcache_cache_set_value_by_identifier(libfcache_cache_t *cache, int file_index, off64_t offset, int64_t timestamp, intptr_t *value, int (*value_free_function)( intptr_t **value, libfcache_error_t **error ), uint8_t flags, libfcache_error_t **error);

int
libfcache_cache_set_value_by_index(libfcache_cache_t *cache, int cache_entry_index, int file_index, off64_t offset, int64_t timestamp, intptr_t *value, int (*value_free_function)( intptr_t **value, libfcache_error_t **error ), uint8_t flags, libfcache_error_t **error);

Cache value functions
int
libfcache_cache_value_free(libfcache_cache_value_t **cache_value, libfcache_error_t **error);

int
libfcache_cache_value_clear(libfcache_cache_value_t *cache_value, libfcache_error_t **error);

int
libfcache_cache_value_get_identifier(libfcache_cache_value_t *cache_value, int *file_index, off64_t *offset, int64_t *timestamp, libfcache_error_t **error);

int
libfcache_cache_value_set_identifier(libfcache_cache_value_t *cache_value, int file_index, off64_t offset, int64_t timestamp, libfcache_error_t **error);

int
libfcache_cache_value_get_value(libfcache_cache_value_t *cache_value, intptr_t **value, libfcache_error_t **error);

int
libfcache_cache_value_set_value(libfcache_cache_value_t *cache_value, intptr_t *value, int (*value_free_function)( intptr_t **value, libfcache_error_t **error ), uint8_t flags, libfcache_error_t **error);

Date time functions
int
libfcache_date_time_get_timestamp(int64_t *timestamp, libfcache_error_t **error);

DESCRIPTION¶

The libfcache_get_version() function is used to retrieve the library version.

RETURN VALUES¶

Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values see "libfcache.h".

ENVIRONMENT¶

None

FILES¶

None

BUGS¶

Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libfcache/issues

AUTHOR¶

These man pages are generated from "libfcache.h".

COPYRIGHT¶

Copyright (C) 2010-2024, Joachim Metz <joachim.metz@gmail.com>.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

SEE ALSO¶

the libfcache.h include file