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

# libfsfat(3)

Library to support the File Allocation Table (FAT) file system format

## NAME

**libfsfat.h** – Library to support the File Allocation Table (FAT) file system format

## SYNOPSIS

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

Support functions

*const* *char* *\**\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

Available when compiled with wide character string support:

*int*\

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

Available when compiled with libbfio support:

*int*\

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

Notify functions

*void*\

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

*int*\

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

*int*\

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

*int*\

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

Error functions

*void*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

Volume functions

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

**libfsfat\_volume\_get\_file\_system\_format**(*libfsfat\_volume\_t \*volume*, *uint8\_t \*file\_system\_format*, *libfsfat\_error\_t \*\*error*);

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

**libfsfat\_volume\_get\_file\_entry\_by\_identifier**(*libfsfat\_volume\_t \*volume*, *uint64\_t identifier*, *libfsfat\_file\_entry\_t \*\*file\_entry*, *libfsfat\_error\_t \*\*error*);

*int*\

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

*int*\

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

Available when compiled with wide character string support:

*int*\

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

Available when compiled with libbfio support:

*int*\

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

File entry functions

*int*\

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

*int*\

**libfsfat\_file\_entry\_get\_identifier**(*libfsfat\_file\_entry\_t \*file\_entry*, *uint64\_t \*identifier*, *libfsfat\_error\_t \*\*error*);

*int*\

**libfsfat\_file\_entry\_get\_access\_time**(*libfsfat\_file\_entry\_t \*file\_entry*, *uint64\_t \*fat\_timestamp*, *libfsfat\_error\_t \*\*error*);

*int*\

**libfsfat\_file\_entry\_get\_creation\_time**(*libfsfat\_file\_entry\_t \*file\_entry*, *uint64\_t \*fat\_timestamp*, *libfsfat\_error\_t \*\*error*);

*int*\

**libfsfat\_file\_entry\_get\_modification\_time**(*libfsfat\_file\_entry\_t \*file\_entry*, *uint64\_t \*fat\_timestamp*, *libfsfat\_error\_t \*\*error*);

*int*\

**libfsfat\_file\_entry\_get\_file\_attribute\_flags**(*libfsfat\_file\_entry\_t \*file\_entry*, *uint16\_t \*file\_attribute\_flags*, *libfsfat\_error\_t \*\*error*);

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*ssize\_t*\

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

*ssize\_t*\

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

*off64\_t*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

## DESCRIPTION

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

## ENVIRONMENT

None

## FILES

None

## NOTES

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

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

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

## BUGS

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

## AUTHOR

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

## COPYRIGHT

Copyright (C) 2021-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 libfsfat.h include file