Provided by: libvslvm-dev_20181227-1.2build1_amd64 
NAME
libvslvm.h — Library to access the Linux Logical Volume Manager (LVM) volume system
LIBRARY
library “libvslvm”
SYNOPSIS
#include <libvslvm.h>
Support functions
const char *
libvslvm_get_version(void);
int
libvslvm_get_access_flags_read_write(void);
int
libvslvm_get_access_flags_write(void);
int
libvslvm_get_codepage(int *codepage, libvslvm_error_t **error);
int
libvslvm_set_codepage(int codepage, libvslvm_error_t **error);
int
libvslvm_check_volume_signature(const char *filename, libvslvm_error_t **error);
Available when compiled with wide character string support:
int
libvslvm_check_volume_signature_wide(const wchar_t *filename, libvslvm_error_t **error);
Available when compiled with libbfio support:
int
libvslvm_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,libvslvm_error_t **error);
Notify functions
void
libvslvm_notify_set_verbose(int verbose);
int
libvslvm_notify_set_stream(FILE *stream, libvslvm_error_t **error);
int
libvslvm_notify_stream_open(const char *filename, libvslvm_error_t **error);
int
libvslvm_notify_stream_close(libvslvm_error_t **error);
Error functions
void
libvslvm_error_free(libvslvm_error_t **error);
int
libvslvm_error_fprint(libvslvm_error_t *error, FILE *stream);
int
libvslvm_error_sprint(libvslvm_error_t *error, char *string, size_t size);
int
libvslvm_error_backtrace_fprint(libvslvm_error_t *error, FILE *stream);
int
libvslvm_error_backtrace_sprint(libvslvm_error_t *error, char *string, size_t size);
Handle functions
int
libvslvm_handle_initialize(libvslvm_handle_t **handle, libvslvm_error_t **error);
int
libvslvm_handle_free(libvslvm_handle_t **handle, libvslvm_error_t **error);
int
libvslvm_handle_signal_abort(libvslvm_handle_t *handle, libvslvm_error_t **error);
int
libvslvm_handle_open(libvslvm_handle_t*handle,constchar*filename,intaccess_flags,libvslvm_error_t**error);
int
libvslvm_handle_open_physical_volume_files(libvslvm_handl*ehc_oftnnidc*sllhteean,ramesin[nu]tm,ber_of_filenamelsi,bvslvm_error*_terror);
int
libvslvm_handle_close(libvslvm_handle_t *handle, libvslvm_error_t **error);
int
libvslvm_handle_get_volume_group(libvslvm_handle*_tandllei,bvslvm_volume_group*_tvolume_groulpi,bvslvm_erro*r*_trror);
Available when compiled with wide character string support:
int
libvslvm_handle_open_wide(libvslvm_handle_thandle,constwchar_t*filename,intaccess_flags,libvslvm_error_t**error);
int
libvslvm_handle_open_physical_volume_files_wide(libvslvm_handl*eh_tndwcflcoiehnl,a*sertn_ntmueimsnb[te]r,_of_filenalmiebsv,slvm_err*o*re_tror);
Available when compiled with libbfio support:
int
libvslvm_handle_open_file_io_handle(libvslvm_hand*lhea_tdllieb,bfio_handl*ef_tle_io_hanadiclncete,ss_flalgisb,vslvm_erro*r*_trror);
int
libvslvm_handle_open_physical_volume_files_file_io_pool(libvslvm_hand*lheal_itdblbef,io_p*ofoill_t_io_piobovls,lvm_er*r*oerr_tor);
Volume group functions
int
libvslvm_volume_group_free(libvslvm_volume_group_t **volume_group, libvslvm_error_t **error);
int
libvslvm_volume_group_get_name_size(libvslvm_volume_group_tvolume_groups,ize_tname_sizel,ibvslvm_error_t*error);
int
libvslvm_volume_group_get_name(libvslvm_volume_group_tvolume_groupc,ha*rnames,ize_tame_sizel,ibvslvm_error_t*error);
int
libvslvm_volume_group_get_identifier_size(libvslvm_volume_gro*uvpo_tume_grsoiuz*pei,_tentifier_silzieb,vslvm_erro*r*_trror);
int
libvslvm_volume_group_get_identifier(libvslvm_volume_grou*pv_tlume_groc*uhipad,rentifsiiiezdree,_ttifier_sliizbev,slvm_err*o*re_tror);
int
libvslvm_volume_group_get_sequence_number(libvslvm_volume_gro*uvpo_tume_gruoiunpt*,3s2e_tuence_numlbiebrv,slvm_erro*r*_trror);
int
libvslvm_volume_group_get_extent_size(libvslvm_volume_group*_tolume_grouspi,ze64*_txtent_sizlei,bvslvm_erro*r*_trror);
int
libvslvm_volume_group_get_number_of_physical_volumes(libvslvm_volume*_*gonrluoumumbpeie_rtgt_roofu_pp,hysical_vloilbuvmselsv,m_e*rerrorro_tint
libvslvm_volume_group_get_physical_volume(libvslvm_volume_gvvrooolluuupmm_ielt__gtibrnvodsuelpxv,,m_physical_v*oplhuymsei_tall_vbovlsulmvem*,_eerrrroorr_tint
libvslvm_volume_group_get_physical_volume_by_name(libvslvv*omvl_uvlsmouielmz_uceenm*h_evantml_raeiglm_rucelvomo,esuennlp_gv_ttmtrh_o,puhpy,sical*_vpohlyusmiec_tll_vbovlsulmvem*,_eerrrroorr_tint
libvslvm_volume_group_get_number_of_logical_volumes(libvslvm_volume_g*rv*oonulupum_bteie_rgt_roofu_pl,ogical_vloilbuvmselsv,m_e*rerrorro_tint
libvslvm_volume_group_get_logical_volume(libvslvm_volume_gvvrooolluuupmm_ielt__gtibrnvodsuelpxv,,m_logical_v*o*lluomgei_tal_vioblvusmlev,m_e*rerrorro_tint
libvslvm_physical_volume_free(libvslvm_physical_volume_t **physical_volume, libvslvm_error_t **error);
int
libvslvm_physical_volume_get_name_size(libvslvm_physical_volume*_thysical_volusmiez*,en_tme_silzieb,vslvm_erro*r*_trror);
int
libvslvm_physical_volume_get_name(libvslvm_physical_volum*ep_tysical_volucmh*ean,ramsei,zen_tme_sizlei,bvslvm_error*_terror);
int
libvslvm_physical_volume_get_identifier_size(libvslvm_physical_vol*upmhey_tical_vos*liiuzdmeee_,ttifier_siibzves,lvm_e*r*reorrr_tr);
int
libvslvm_physical_volume_get_identifier(libvslvm_physical_vol*upmhey_tical_viocdlheuanmrteisi,fidizeeenr_,tifier_siibzves,lvm_err*o*re_tror);
int
libvslvm_physical_volume_get_device_path_size(libvslvm_physical_vol*upmhey_tical_v*osdlieuzvmeie_,te_pathl_sbivzsel,vm_e*r*reorrr_tr);
int
libvslvm_physical_volume_get_device_path(libvslvm_physical_vo*lpuhmyes_tcal*_vceohvlaiurcmee_d,pieazvteih_,te_path_siibzves,lvm_er*r*oerr_tor);
int
libvslvm_physical_volume_get_size(libvslvm_physical_volume_tphysical_volumes,ize64_tsizel,ibvslvm_error*_terror);
Logical volume functions
int
libvslvm_logical_volume_free(libvslvm_logical_volume_t **logical_volume, libvslvm_error_t **error);
ssize_t
libvslvm_logical_volume_read_buffer(libvslvm_logical_volum*el_tgical_voluv*mobeiu,dffseirzb,eu_tfer_silzieb,vslvm_error*_terror);
ssize_t
libvslvm_logical_volume_read_buffer_at_offset(libvslvm_logical_volu*mleo_tical_vo*lvbuousbmifiuedfzf,eefr_,tr_sfoifflz6fie4sb,_vtts,lvm_er*r*oerr_tor);
off64_t
libvslvm_logical_volume_seek_offset(libvslvm_logical_volume*_togical_volumoef,f64o_tfseiwtnh,tenclei,bvslvm_error*_terror);
int
libvslvm_logical_volume_get_offset(libvslvm_logical_volume_tlogical_volumeo,ff64_toffsetl,ibvslvm_error*_terror);
int
libvslvm_logical_volume_get_size(libvslvm_logical_volume_tlogical_volumes,ize64_tsize,libvslvm_error_t**error);
int
libvslvm_logical_volume_get_name_size(libvslvm_logical_volume*_togical_volumsei,ze*_tame_sizlei,bvslvm_erro*r*_trror);
int
libvslvm_logical_volume_get_name(libvslvm_logical_volume*_togical_volumceh*,anramsei,zen_tme_sizlei,bvslvm_error_t*error);
int
libvslvm_logical_volume_get_identifier_size(libvslvm_logical_volu*mleo_tical_vols*uiimzdeee,_ttifier_siibzves,lvm_er*r*oerr_tor);
int
libvslvm_logical_volume_get_identifier(libvslvm_logical_vol*ulmoeg_tcal_viocdlheuanmrtei,fsiiiezdree,_ttifier_sliizbev,slvm_err*o*re_tror);
int
libvslvm_logical_volume_get_number_of_segments(libvslvm_logical_vol*ulmoeg_tcal*_vuoimlnbutemre_,of_segmleinbtvss,lvm_e*r*reorrr_tr);
int
libvslvm_logical_volume_get_segment(libvslvm_logical_vol*ulmoeg_tcals_vgoimlneutnmte_,ilnidbevxs,lvm_segm*e*nste_ltmiebnvts,lvm_er*r*oerr_tor);
Segment functions
int
libvslvm_segment_free(libvslvm_segment_t **segment, libvslvm_error_t **error);
int
libvslvm_segment_get_offset(libvslvm_segment_t *segment, off64_t *offset, libvslvm_error_t **error);
int
libvslvm_segment_get_size(libvslvm_segment_t *segment, size64_t *size, libvslvm_error_t **error);
int
libvslvm_segment_get_number_of_stripes(libvslvm_segment_t*segment,in*tnumber_of_stripesl,ibvslvm_error_t*error);
int
libvslvm_segment_get_stripe(libvslvm_segment*_tegmenistnt,tripe_indexl,ibvslvm_stripe_t*stripel,ibvslvm_error_t*error);
Stripe functions
int
libvslvm_stripe_free(libvslvm_stripe_t **stripe, libvslvm_error_t **error);
int
libvslvm_stripe_get_physical_volume_name_size(libvslvm_strip*es_trsii*pzpeeh,_tsical_volume_name_sliizbev,slvm_err*o*re_tror);
int
libvslvm_stripe_get_physical_volume_name(libvslvm_s*t*prschithypraseiri_ctea,l_volume_pnihazymese_,tcal_volume_name_siibzves,lvm_er*r*oerr_tor);
int
libvslvm_stripe_get_data_area_offset(libvslvm_stripe_t*stripe,off64_t*data_area_offsetl,ibvslvm_error_t*error);
DESCRIPTION
The libvslvm_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 "libvslvm.h".
ENVIRONMENT
None
FILES
None
NOTES
libvslvm allows to be compiled with wide character support (wchar_t).
To compile libvslvm with wide character support use: ./configure --enable-wide-character-type=yes
or define: _UNICODE
or UNICODE
during compilation.
LIBVSLVM_WIDE_CHARACTER_TYPE
in libvslvm/features.h can be used to determine if libvslvm was compiled with wide character support.
BUGS
Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libvslvm/issues
AUTHOR
These man pages are generated from "libvslvm.h".
COPYRIGHT
Copyright (C) 2014-2018, 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 libvslvm.h include file
libvslvm January 9, 2016 libvslvm(3)