---
name: "libmodi"
section: "3"
platform: "linux"
package: "libmodi-dev"
version: "0~20240507-2+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/libmodi"
---

# libmodi(3)

Library to access Mac OS disk image formats

## NAME

**libmodi.h** – Library to access Mac OS disk image formats

## SYNOPSIS

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

Support functions

*const* *char* *\**\

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

*int*\

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

*int*\

**libmodi\_get\_access\_flags\_read\_write**(*void*);

*int*\

**libmodi\_get\_access\_flags\_write**(*void*);

*int*\

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

*int*\

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

*int*\

**libmodi\_check\_file\_signature**(*const char \*filename*, *libmodi\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libmodi\_check\_file\_signature\_wide**(*const wchar\_t \*filename*, *libmodi\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

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

Notify functions

*void*\

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

*int*\

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

*int*\

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

*int*\

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

Error functions

*void*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

Handle functions

*int*\

**libmodi\_handle\_initialize**(*libmodi\_handle\_t \*\*handle*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_free**(*libmodi\_handle\_t \*\*handle*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_signal\_abort**(*libmodi\_handle\_t \*handle*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_open**(*libmodi\_handle\_t \*handle*, *const char \*filename*, *int access\_flags*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_open\_band\_data\_files**(*libmodi\_handle\_t \*handle*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_close**(*libmodi\_handle\_t \*handle*, *libmodi\_error\_t \*\*error*);

*ssize\_t*\

**libmodi\_handle\_read\_buffer**(*libmodi\_handle\_t \*handle*, *void \*buffer*, *size\_t buffer\_size*, *libmodi\_error\_t \*\*error*);

*ssize\_t*\

**libmodi\_handle\_read\_buffer\_at\_offset**(*libmodi\_handle\_t \*handle*, *void \*buffer*, *size\_t buffer\_size*, *off64\_t offset*, *libmodi\_error\_t \*\*error*);

*off64\_t*\

**libmodi\_handle\_seek\_offset**(*libmodi\_handle\_t \*handle*, *off64\_t offset*, *int whence*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_get\_offset**(*libmodi\_handle\_t \*handle*, *off64\_t \*offset*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_set\_maximum\_number\_of\_open\_handles**(*libmodi\_handle\_t \*handle*, *int maximum\_number\_of\_open\_handles*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_set\_band\_data\_files\_path**(*libmodi\_handle\_t \*handle*, *const char \*path*, *size\_t path\_length*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_get\_media\_size**(*libmodi\_handle\_t \*handle*, *size64\_t \*media\_size*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_get\_image\_type**(*libmodi\_handle\_t \*handle*, *int \*image\_type*, *libmodi\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libmodi\_handle\_open\_wide**(*libmodi\_handle\_t \*handle*, *const wchar\_t \*filename*, *int access\_flags*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_set\_band\_data\_files\_path\_wide**(*libmodi\_handle\_t \*handle*, *const wchar\_t \*path*, *size\_t path\_length*, *libmodi\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

**libmodi\_handle\_open\_file\_io\_handle**(*libmodi\_handle\_t \*handle*, *libbfio\_handle\_t \*file\_io\_handle*, *int access\_flags*, *libmodi\_error\_t \*\*error*);

*int*\

**libmodi\_handle\_open\_band\_data\_files\_file\_io\_pool**(*libmodi\_handle\_t \*handle*, *libbfio\_pool\_t \*file\_io\_pool*, *libmodi\_error\_t \*\*error*);

## DESCRIPTION

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

## ENVIRONMENT

None

## FILES

None

## NOTES

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

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

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

## BUGS

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

## AUTHOR

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

## COPYRIGHT

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