NAME

       libscca.h — Library to access the Windows Prefetch File (PF) format

LIBRARY

       library “libscca”

SYNOPSIS

       #include <libscca.h>

       Support functions

       const char *
       libscca_get_version(void);

       int
       libscca_get_access_flags_read(void);

       int
       libscca_get_codepage(int *codepage, libscca_error_t **error);

       int
       libscca_set_codepage(int codepage, libscca_error_t **error);

       int
       libscca_check_file_signature(const char *filename, libscca_error_t **error);

       Available when compiled with wide character string support:

       int
       libscca_check_file_signature_wide(const wchar_t *filename, libscca_error_t **error);

       Available when compiled with libbfio support:

       int
       libscca_check_file_signature_file_io_handle(libbfio_handle_t *file_io_handle, libscca_error_t **error);

       Notify functions

       void
       libscca_notify_set_verbose(int verbose);

       int
       libscca_notify_set_stream(FILE *stream, libscca_error_t **error);

       int
       libscca_notify_stream_open(const char *filename, libscca_error_t **error);

       int
       libscca_notify_stream_close(libscca_error_t **error);

       Error functions

       void
       libscca_error_free(libscca_error_t **error);

       int
       libscca_error_fprint(libscca_error_t *error, FILE *stream);

       int
       libscca_error_sprint(libscca_error_t *error, char *string, size_t size);

       int
       libscca_error_backtrace_fprint(libscca_error_t *error, FILE *stream);

       int
       libscca_error_backtrace_sprint(libscca_error_t *error, char *string, size_t size);

       File functions

       int
       libscca_file_initialize(libscca_file_t **file, libscca_error_t **error);

       int
       libscca_file_free(libscca_file_t **file, libscca_error_t **error);

       int
       libscca_file_signal_abort(libscca_file_t *file, libscca_error_t **error);

       int
       libscca_file_open(libscca_file_t *file, const char *filename, int access_flags, libscca_error_t **error);

       int
       libscca_file_close(libscca_file_t *file, libscca_error_t **error);

       int
       libscca_file_get_format_version(libscca_file_t *file, uint32_t *format_version, libscca_error_t **error);

       int
       libscca_file_get_utf8_executable_filename_size(libscca_file_tfiles,ize_tutf8_string_sizel,ibscca_error_t*error);

       int
       libscca_file_get_utf8_executable_filename(libscca_file*_tiluei,nt8*_ttf8_strinsgi,zuet_t8_string_silzieb,scca_erro*r*_trror);

       int
       libscca_file_get_utf16_executable_filename_size(libscca_file*_tilsei,ze_tutf16_string_sizel,ibscca_error_t*error);

       int
       libscca_file_get_utf16_executable_filename(libscca_fil*ef_utlien,t1*6u_tf16_strisnigzu,et_t16_string_silzieb,scca_erro*r*_trror);

       int
       libscca_file_get_prefetch_hash(libscca_file_t *file, uint32_t *prefetch_hash, libscca_error_t **error);

       int
       libscca_file_get_last_run_time(libscca_file_tfilei,nltast_run_time_indexu,int64_t*filetime,libscca_error_t**error);

       int
       libscca_file_get_run_count(libscca_file_t *file, uint32_t *run_count, libscca_error_t **error);

       int
       libscca_file_get_number_of_file_metrics_entries(libscca_file_t*filei,n*tnumber_of_entriesl,ibscca_error_t*error);

       int
       libscca_file_get_file_metrics_entry(libscca_fil*efe_intlntetr,y_indleixb,scca_file_metric*s*_tile_metrilcisb,scca_error*_terror);

       int
       libscca_file_get_number_of_filenames(libscca_file_t*file,int*number_of_filenames,libscca_error_t**error);

       int
       libscca_file_get_utf8_filename_size(libscca_file*_tilifeni,tlename_indexs,ize_tutf8_string_sizel,ibscca_error_t*error);

       int
       libscca_file_get_utf8_filename(libscca_file*_tilifeni,tlename_indeuxi,nt8*_ttf8_strisnigzu,et_t8_string_silzieb,scca_erro*r*_trror);

       int
       libscca_file_get_utf16_filename_size(libscca_file*_tilifeni,tlename_indesxi,ze*_ttf16_string_sizel,ibscca_error_t*error);

       int
       libscca_file_get_utf16_filename(libscca_file*_ftiiilnlete,name_indueixn,t1*6u_tf16_strisnigzu,et_t16_string_silzieb,scca_erro*r*_trror);

       int
       libscca_file_get_number_of_volumes(libscca_file_t*file, int *number_of_volumes, libscca_error_t **error);

       int
       libscca_file_get_volume_information(libscca_foi*llfiueinm_tete_,ilnidbesxc,ca_volume_informat*i*ovno_tume_informaltiibosnc,ca_er*r*oerr_tor);

       Available when compiled with wide character string support:

       int
       libscca_file_open_wide(libscca_file_t*file,constwchar_t*filename,intaccess_flags,libscca_error_t**error);

       Available when compiled with libbfio support:

       int
       libscca_file_open_file_io_handle(libscca_file_tfillei,bbfio_handle*_tile_io_handliaenc,tcess_flaglsi,bscca_error*_terror);

       File metrics functions

       int
       libscca_file_metrics_free(libscca_file_metrics_t **file_metrics, libscca_error_t **error);

       int
       libscca_file_metrics_get_utf8_filename_size(libscca_file_metri*cfsi_te_metrsii*czuset,_t8_string_silzieb,scca_erro*r*_trror);

       int
       libscca_file_metrics_get_utf8_filename(libscca_file_metri*cfsi_te_metruiicn*stu,8t_t8_strsiiunztgef,_t_string_siibzsec,ca_er*r*oerr_tor);

       int
       libscca_file_metrics_get_utf16_filename_size(libscca_file_metri*cfsi_te_metrsii*czuset,_t16_string_sliizbes,cca_err*o*re_tror);

       int
       libscca_file_metrics_get_utf16_filename(libscca_file_metri*cfsi_te_meturiin*ctus1t,6f_t6_stsuritizfne1g_,t_string_siibzsec,ca_er*r*oerr_tor);

       int
       libscca_file_metrics_get_file_reference(libscca_file_metric*sf_tle_metriucisn,t6*4f_tle_referenlcieb,scca_error*_terror);

       Volume information functions

       int
       libscca_volume_information_free(libscca_volume_information_t**volume_information,libscca_error_t**error);

       int
       libscca_volume_information_get_creation_time(libscca_volume_informat*ivoonl_tme_informautiin*otfn6i,4l_lttiibmsec,ca_er*r*oerr_tor);

       int
       libscca_volume_information_get_serial_number(libscca_volume_informa*tvioolnu_te_informuai*tnsiteo3rn2i,_tl_nluimbbsecrc,a_e*r*reorrr_tr);

       int
       libscca_volume_information_get_utf8_device_path_size(libscca_volume_infor*mvaotliuomne_ti*nuftosfri8mz_aest_itroilnni,gb_sciczae_,e*rerrorro_tint
       libscca_volume_information_get_utf8_device_path(libscca_volume_inform*avtoilounm_t_info*ruumitanfutt8ti8_fo_i8nttz_,resi_ntrgil,nigb_scicza*e_,eerrrroorr_tint
       libscca_volume_information_get_utf16_device_path_size(libscca_volume_info*rvmoaltuimoen__*tnuftosfri1mz6ae_t_ittornil,nigb_scicza*e_,eerrrroorr_tint
       libscca_volume_information_get_utf16_device_path(libscca_volume_inform*avtoilounm_t_inf*ouuritumnftat1ft16s1i6_6o_z_nttes,r_itrnilgni,gb_scicza*e_,eerrrroorr_t
DESCRIPTION
       The libscca_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 "libscca.h".

ENVIRONMENT
       None

FILES
       None

NOTES
       libscca allows to be compiled with wide character support (wchar_t).

       To compile libscca with wide character support use: ./configure --enable-wide-character-type=yes
        or define: _UNICODE
        or UNICODE
        during compilation.

       LIBSCCA_WIDE_CHARACTER_TYPE
        in libscca/features.h can be used to determine if libscca was compiled with wide character support.

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

AUTHOR
       These man pages are generated from "libscca.h".

COPYRIGHT
       Copyright (C) 2011-2017, 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 libscca.h include file

libscca                                          January 4, 2017                                      libscca(3)