1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
.Dd November 11, 2020
.Dt libfsxfs 3
.Os libfsxfs
.Sh NAME
.Nm libfsxfs.h
.Nd Library to support the X File System (XFS) format
.Sh SYNOPSIS
.In libfsxfs.h
.Pp
Support functions
.Ft const char *
.Fn libfsxfs_get_version "void"
.Ft int
.Fn libfsxfs_get_access_flags_read "void"
.Ft int
.Fn libfsxfs_get_codepage "int *codepage" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_set_codepage "int codepage" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_check_volume_signature "const char *filename" "libfsxfs_error_t **error"
.Pp
Available when compiled with wide character string support:
.Ft int
.Fn libfsxfs_check_volume_signature_wide "const wchar_t *filename" "libfsxfs_error_t **error"
.Pp
Available when compiled with libbfio support:
.Ft int
.Fn libfsxfs_check_volume_signature_file_io_handle "libbfio_handle_t *file_io_handle" "libfsxfs_error_t **error"
.Pp
Notify functions
.Ft void
.Fn libfsxfs_notify_set_verbose "int verbose"
.Ft int
.Fn libfsxfs_notify_set_stream "FILE *stream" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_notify_stream_open "const char *filename" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_notify_stream_close "libfsxfs_error_t **error"
.Pp
Error functions
.Ft void
.Fn libfsxfs_error_free "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_error_fprint "libfsxfs_error_t *error" "FILE *stream"
.Ft int
.Fn libfsxfs_error_sprint "libfsxfs_error_t *error" "char *string" "size_t size"
.Ft int
.Fn libfsxfs_error_backtrace_fprint "libfsxfs_error_t *error" "FILE *stream"
.Ft int
.Fn libfsxfs_error_backtrace_sprint "libfsxfs_error_t *error" "char *string" "size_t size"
.Pp
Volume functions
.Ft int
.Fn libfsxfs_volume_initialize "libfsxfs_volume_t **volume" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_free "libfsxfs_volume_t **volume" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_signal_abort "libfsxfs_volume_t *volume" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_open "libfsxfs_volume_t *volume" "const char *filename" "int access_flags" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_close "libfsxfs_volume_t *volume" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_format_version "libfsxfs_volume_t *volume" "uint8_t *format_version" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_utf8_label_size "libfsxfs_volume_t *volume" "size_t *utf8_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_utf8_label "libfsxfs_volume_t *volume" "uint8_t *utf8_string" "size_t utf8_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_utf16_label_size "libfsxfs_volume_t *volume" "size_t *utf16_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_utf16_label "libfsxfs_volume_t *volume" "uint16_t *utf16_string" "size_t utf16_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_file_entry_by_inode "libfsxfs_volume_t *volume" "uint64_t inode_number" "libfsxfs_file_entry_t **file_entry" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_root_directory "libfsxfs_volume_t *volume" "libfsxfs_file_entry_t **file_entry" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_file_entry_by_utf8_path "libfsxfs_volume_t *volume" "const uint8_t *utf8_string" "size_t utf8_string_length" "libfsxfs_file_entry_t **file_entry" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_volume_get_file_entry_by_utf16_path "libfsxfs_volume_t *volume" "const uint16_t *utf16_string" "size_t utf16_string_length" "libfsxfs_file_entry_t **file_entry" "libfsxfs_error_t **error"
.Pp
Available when compiled with wide character string support:
.Ft int
.Fn libfsxfs_volume_open_wide "libfsxfs_volume_t *volume" "const wchar_t *filename" "int access_flags" "libfsxfs_error_t **error"
.Pp
Available when compiled with libbfio support:
.Ft int
.Fn libfsxfs_volume_open_file_io_handle "libfsxfs_volume_t *volume" "libbfio_handle_t *file_io_handle" "int access_flags" "libfsxfs_error_t **error"
.Pp
File entry functions
.Ft int
.Fn libfsxfs_file_entry_free "libfsxfs_file_entry_t **file_entry" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_inode_number "libfsxfs_file_entry_t *file_entry" "uint64_t *inode_number" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_creation_time "libfsxfs_file_entry_t *file_entry" "int64_t *posix_time" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_modification_time "libfsxfs_file_entry_t *file_entry" "int64_t *posix_time" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_access_time "libfsxfs_file_entry_t *file_entry" "int64_t *posix_time" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_inode_change_time "libfsxfs_file_entry_t *file_entry" "int64_t *posix_time" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_file_mode "libfsxfs_file_entry_t *file_entry" "uint16_t *file_mode" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_owner_identifier "libfsxfs_file_entry_t *file_entry" "uint32_t *owner_identifier" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_group_identifier "libfsxfs_file_entry_t *file_entry" "uint32_t *group_identifier" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf8_name_size "libfsxfs_file_entry_t *file_entry" "size_t *utf8_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf8_name "libfsxfs_file_entry_t *file_entry" "uint8_t *utf8_string" "size_t utf8_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf16_name_size "libfsxfs_file_entry_t *file_entry" "size_t *utf16_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf16_name "libfsxfs_file_entry_t *file_entry" "uint16_t *utf16_string" "size_t utf16_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf8_symbolic_link_target_size "libfsxfs_file_entry_t *file_entry" "size_t *utf8_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf8_symbolic_link_target "libfsxfs_file_entry_t *file_entry" "uint8_t *utf8_string" "size_t utf8_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf16_symbolic_link_target_size "libfsxfs_file_entry_t *file_entry" "size_t *utf16_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_utf16_symbolic_link_target "libfsxfs_file_entry_t *file_entry" "uint16_t *utf16_string" "size_t utf16_string_size" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_number_of_sub_file_entries "libfsxfs_file_entry_t *file_entry" "int *number_of_sub_entries" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_sub_file_entry_by_index "libfsxfs_file_entry_t *file_entry" "int sub_file_entry_index" "libfsxfs_file_entry_t **sub_file_entry" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_sub_file_entry_by_utf8_name "libfsxfs_file_entry_t *file_entry" "const uint8_t *utf8_string" "size_t utf8_string_length" "libfsxfs_file_entry_t **sub_file_entry" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_sub_file_entry_by_utf16_name "libfsxfs_file_entry_t *file_entry" "const uint16_t *utf16_string" "size_t utf16_string_length" "libfsxfs_file_entry_t **sub_file_entry" "libfsxfs_error_t **error"
.Ft ssize_t
.Fn libfsxfs_file_entry_read_buffer "libfsxfs_file_entry_t *file_entry" "void *buffer" "size_t buffer_size" "libfsxfs_error_t **error"
.Ft ssize_t
.Fn libfsxfs_file_entry_read_buffer_at_offset "libfsxfs_file_entry_t *file_entry" "void *buffer" "size_t buffer_size" "off64_t offset" "libfsxfs_error_t **error"
.Ft off64_t
.Fn libfsxfs_file_entry_seek_offset "libfsxfs_file_entry_t *file_entry" "off64_t offset" "int whence" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_offset "libfsxfs_file_entry_t *file_entry" "off64_t *offset" "libfsxfs_error_t **error"
.Ft int
.Fn libfsxfs_file_entry_get_size "libfsxfs_file_entry_t *file_entry" "size64_t *size" "libfsxfs_error_t **error"
.Sh DESCRIPTION
The
.Fn libfsxfs_get_version
function is used to retrieve the library version.
.Sh RETURN VALUES
Most of the functions return NULL or \-1 on error, dependent on the return type.
For the actual return values see "libfsxfs.h".
.Sh ENVIRONMENT
None
.Sh FILES
None
.Sh NOTES
libfsxfs can be compiled with wide character support (wchar_t).
.sp
To compile libfsxfs with wide character support use:
.Ar ./configure --enable-wide-character-type=yes
or define:
.Ar _UNICODE
or
.Ar UNICODE
during compilation.
.sp
.Ar LIBFSXFS_WIDE_CHARACTER_TYPE
in libfsxfs/features.h can be used to determine if libfsxfs was compiled with wide character support.
.Sh BUGS
Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libfsxfs/issues
.Sh AUTHOR
These man pages are generated from "libfsxfs.h".
.Sh COPYRIGHT
Copyright (C) 2020, Joachim Metz <joachim.metz@gmail.com>.
.sp
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.Sh SEE ALSO
the libfsxfs.h include file
|
