---
name: "libfsext"
section: "3"
platform: "linux"
package: "libfsext-dev"
version: "20240501-1+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/libfsext"
---

# libfsext(3)

Library to support the Extended File System (ext) format

## NAME

**libfsext.h** – Library to support the Extended File System (ext) format

## SYNOPSIS

**#include \<libfsext.h\>**

Support functions

*const* *char* *\**\

**libfsext\_get\_version**(*void*);

*int*\

**libfsext\_get\_access\_flags\_read**(*void*);

*int*\

**libfsext\_get\_codepage**(*int \*codepage*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_set\_codepage**(*int codepage*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_check\_volume\_signature**(*const char \*filename*, *libfsext\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libfsext\_check\_volume\_signature\_wide**(*const wchar\_t \*filename*, *libfsext\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

**libfsext\_check\_volume\_signature\_file\_io\_handle**(*libbfio\_handle\_t \*file\_io\_handle*, *libfsext\_error\_t \*\*error*);

Notify functions

*void*\

**libfsext\_notify\_set\_verbose**(*int verbose*);

*int*\

**libfsext\_notify\_set\_stream**(*FILE \*stream*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_notify\_stream\_open**(*const char \*filename*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_notify\_stream\_close**(*libfsext\_error\_t \*\*error*);

Error functions

*void*\

**libfsext\_error\_free**(*libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_error\_fprint**(*libfsext\_error\_t \*error*, *FILE \*stream*);

*int*\

**libfsext\_error\_sprint**(*libfsext\_error\_t \*error*, *char \*string*, *size\_t size*);

*int*\

**libfsext\_error\_backtrace\_fprint**(*libfsext\_error\_t \*error*, *FILE \*stream*);

*int*\

**libfsext\_error\_backtrace\_sprint**(*libfsext\_error\_t \*error*, *char \*string*, *size\_t size*);

Volume functions

*int*\

**libfsext\_volume\_initialize**(*libfsext\_volume\_t \*\*volume*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_free**(*libfsext\_volume\_t \*\*volume*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_signal\_abort**(*libfsext\_volume\_t \*volume*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_open**(*libfsext\_volume\_t \*volume*, *const char \*filename*, *int access\_flags*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_close**(*libfsext\_volume\_t \*volume*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_format\_version**(*libfsext\_volume\_t \*volume*, *uint8\_t \*format\_version*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_features\_flags**(*libfsext\_volume\_t \*volume*, *uint32\_t \*compatible\_features\_flags*, *uint32\_t \*incompatible\_features\_flags*, *uint32\_t \*read\_only\_compatible\_features\_flags*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_identifier**(*libfsext\_volume\_t \*volume*, *uint8\_t \*uuid\_data*, *size\_t uuid\_data\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf8\_label\_size**(*libfsext\_volume\_t \*volume*, *size\_t \*utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf8\_label**(*libfsext\_volume\_t \*volume*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf16\_label\_size**(*libfsext\_volume\_t \*volume*, *size\_t \*utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf16\_label**(*libfsext\_volume\_t \*volume*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf8\_last\_mount\_path\_size**(*libfsext\_volume\_t \*volume*, *size\_t \*utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf8\_last\_mount\_path**(*libfsext\_volume\_t \*volume*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf16\_last\_mount\_path\_size**(*libfsext\_volume\_t \*volume*, *size\_t \*utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_utf16\_last\_mount\_path**(*libfsext\_volume\_t \*volume*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_last\_mount\_time**(*libfsext\_volume\_t \*volume*, *int32\_t \*posix\_time*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_last\_written\_time**(*libfsext\_volume\_t \*volume*, *int32\_t \*posix\_time*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_root\_directory**(*libfsext\_volume\_t \*volume*, *libfsext\_file\_entry\_t \*\*file\_entry*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_number\_of\_file\_entries**(*libfsext\_volume\_t \*volume*, *uint32\_t \*number\_of\_file\_entries*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_file\_entry\_by\_inode**(*libfsext\_volume\_t \*volume*, *uint32\_t inode\_number*, *libfsext\_file\_entry\_t \*\*file\_entry*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_file\_entry\_by\_utf8\_path**(*libfsext\_volume\_t \*volume*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libfsext\_file\_entry\_t \*\*file\_entry*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_volume\_get\_file\_entry\_by\_utf16\_path**(*libfsext\_volume\_t \*volume*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libfsext\_file\_entry\_t \*\*file\_entry*, *libfsext\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libfsext\_volume\_open\_wide**(*libfsext\_volume\_t \*volume*, *const wchar\_t \*filename*, *int access\_flags*, *libfsext\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

**libfsext\_volume\_open\_file\_io\_handle**(*libfsext\_volume\_t \*volume*, *libbfio\_handle\_t \*file\_io\_handle*, *int access\_flags*, *libfsext\_error\_t \*\*error*);

File entry functions

*int*\

**libfsext\_file\_entry\_free**(*libfsext\_file\_entry\_t \*\*file\_entry*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_is\_empty**(*libfsext\_file\_entry\_t \*file\_entry*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_inode\_number**(*libfsext\_file\_entry\_t \*file\_entry*, *uint32\_t \*inode\_number*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_access\_time**(*libfsext\_file\_entry\_t \*file\_entry*, *int64\_t \*posix\_time*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_creation\_time**(*libfsext\_file\_entry\_t \*file\_entry*, *int64\_t \*posix\_time*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_inode\_change\_time**(*libfsext\_file\_entry\_t \*file\_entry*, *int64\_t \*posix\_time*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_modification\_time**(*libfsext\_file\_entry\_t \*file\_entry*, *int64\_t \*posix\_time*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_deletion\_time**(*libfsext\_file\_entry\_t \*file\_entry*, *int32\_t \*posix\_time*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_file\_mode**(*libfsext\_file\_entry\_t \*file\_entry*, *uint16\_t \*file\_mode*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_number\_of\_links**(*libfsext\_file\_entry\_t \*file\_entry*, *uint16\_t \*number\_of\_links*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_owner\_identifier**(*libfsext\_file\_entry\_t \*file\_entry*, *uint32\_t \*owner\_identifier*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_group\_identifier**(*libfsext\_file\_entry\_t \*file\_entry*, *uint32\_t \*group\_identifier*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_device\_identifier**(*libfsext\_file\_entry\_t \*file\_entry*, *uint32\_t \*device\_identifier*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_device\_number**(*libfsext\_file\_entry\_t \*file\_entry*, *uint8\_t \*major\_device\_number*, *uint8\_t \*minor\_device\_number*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf8\_name\_size**(*libfsext\_file\_entry\_t \*file\_entry*, *size\_t \*utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf8\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf16\_name\_size**(*libfsext\_file\_entry\_t \*file\_entry*, *size\_t \*utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf16\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf8\_symbolic\_link\_target\_size**(*libfsext\_file\_entry\_t \*file\_entry*, *size\_t \*utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf8\_symbolic\_link\_target**(*libfsext\_file\_entry\_t \*file\_entry*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf16\_symbolic\_link\_target\_size**(*libfsext\_file\_entry\_t \*file\_entry*, *size\_t \*utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_utf16\_symbolic\_link\_target**(*libfsext\_file\_entry\_t \*file\_entry*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_number\_of\_extended\_attributes**(*libfsext\_file\_entry\_t \*file\_entry*, *int \*number\_of\_extended\_attributes*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_extended\_attribute\_by\_index**(*libfsext\_file\_entry\_t \*file\_entry*, *int extended\_attribute\_index*, *libfsext\_extended\_attribute\_t \*\*extended\_attribute*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_has\_extended\_attribute\_by\_utf8\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_has\_extended\_attribute\_by\_utf16\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_extended\_attribute\_by\_utf8\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libfsext\_extended\_attribute\_t \*\*extended\_attribute*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_extended\_attribute\_by\_utf16\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libfsext\_extended\_attribute\_t \*\*extended\_attribute*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_number\_of\_sub\_file\_entries**(*libfsext\_file\_entry\_t \*file\_entry*, *int \*number\_of\_sub\_entries*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_sub\_file\_entry\_by\_index**(*libfsext\_file\_entry\_t \*file\_entry*, *int sub\_file\_entry\_index*, *libfsext\_file\_entry\_t \*\*sub\_file\_entry*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_sub\_file\_entry\_by\_utf8\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libfsext\_file\_entry\_t \*\*sub\_file\_entry*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_sub\_file\_entry\_by\_utf16\_name**(*libfsext\_file\_entry\_t \*file\_entry*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libfsext\_file\_entry\_t \*\*sub\_file\_entry*, *libfsext\_error\_t \*\*error*);

*ssize\_t*\

**libfsext\_file\_entry\_read\_buffer**(*libfsext\_file\_entry\_t \*file\_entry*, *void \*buffer*, *size\_t buffer\_size*, *libfsext\_error\_t \*\*error*);

*ssize\_t*\

**libfsext\_file\_entry\_read\_buffer\_at\_offset**(*libfsext\_file\_entry\_t \*file\_entry*, *void \*buffer*, *size\_t buffer\_size*, *off64\_t offset*, *libfsext\_error\_t \*\*error*);

*off64\_t*\

**libfsext\_file\_entry\_seek\_offset**(*libfsext\_file\_entry\_t \*file\_entry*, *off64\_t offset*, *int whence*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_offset**(*libfsext\_file\_entry\_t \*file\_entry*, *off64\_t \*offset*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_size**(*libfsext\_file\_entry\_t \*file\_entry*, *size64\_t \*size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_number\_of\_extents**(*libfsext\_file\_entry\_t \*file\_entry*, *int \*number\_of\_extents*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_file\_entry\_get\_extent\_by\_index**(*libfsext\_file\_entry\_t \*file\_entry*, *int extent\_index*, *off64\_t \*extent\_offset*, *size64\_t \*extent\_size*, *uint32\_t \*extent\_flags*, *libfsext\_error\_t \*\*error*);

Extended attribute functions

*int*\

**libfsext\_extended\_attribute\_free**(*libfsext\_extended\_attribute\_t \*\*extended\_attribute*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_utf8\_name\_size**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *size\_t \*utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_utf8\_name**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_utf16\_name\_size**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *size\_t \*utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_utf16\_name**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libfsext\_error\_t \*\*error*);

*ssize\_t*\

**libfsext\_extended\_attribute\_read\_buffer**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *void \*buffer*, *size\_t buffer\_size*, *libfsext\_error\_t \*\*error*);

*ssize\_t*\

**libfsext\_extended\_attribute\_read\_buffer\_at\_offset**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *void \*buffer*, *size\_t buffer\_size*, *off64\_t offset*, *libfsext\_error\_t \*\*error*);

*off64\_t*\

**libfsext\_extended\_attribute\_seek\_offset**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *off64\_t offset*, *int whence*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_offset**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *off64\_t \*offset*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_size**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *size64\_t \*size*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_number\_of\_extents**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *int \*number\_of\_extents*, *libfsext\_error\_t \*\*error*);

*int*\

**libfsext\_extended\_attribute\_get\_extent\_by\_index**(*libfsext\_extended\_attribute\_t \*extended\_attribute*, *int extent\_index*, *off64\_t \*extent\_offset*, *size64\_t \*extent\_size*, *uint32\_t \*extent\_flags*, *libfsext\_error\_t \*\*error*);

## DESCRIPTION

The **libfsext\_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 "libfsext.h".

## ENVIRONMENT

None

## FILES

None

## NOTES

libfsext can be compiled with wide character support (wchar\_t).

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

*LIBFSEXT\_WIDE\_CHARACTER\_TYPE*\
  in libfsext/features.h can be used to determine if libfsext was compiled with wide character support.

## BUGS

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

## AUTHOR

These man pages are generated from "libfsext.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 libfsext.h include file