---
name: "libsmdev"
section: "3"
platform: "linux"
package: "libsmdev-dev"
version: "20190315-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/libsmdev"
---

# libsmdev(3)

Library to access and read storage media (SM) devices

## NAME

**libsmdev.h** – Library to access and read storage media (SM) devices

## SYNOPSIS

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

Support functions

*const* *char* *\**\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

**libsmdev\_check\_device**(*const char \*filename*, *libsmdev\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libsmdev\_check\_device\_wide**(*const wchar\_t \*filename*, *libsmdev\_error\_t \*\*error*);

Notify functions

*void*\

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

*int*\

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

*int*\

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

*int*\

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

Error functions

*void*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

Handle functions

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*int*\

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

*ssize\_t*\

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

*ssize\_t*\

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

*ssize\_t*\

**libsmdev\_handle\_write\_buffer**(*libsmdev\_handle\_t \*handle*, *const uint8\_t \*buffer*, *size\_t buffer\_size*, *libsmdev\_error\_t \*\*error*);

*ssize\_t*\

**libsmdev\_handle\_write\_buffer\_at\_offset**(*libsmdev\_handle\_t \*handle*, *const uint8\_t \*buffer*, *size\_t buffer\_size*, *off64\_t offset*, *libsmdev\_error\_t \*\*error*);

*off64\_t*\

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

*int*\

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

*int*\

**libsmdev\_handle\_get\_filename\_size**(*libsmdev\_handle\_t \*handle*, *size\_t \*filename\_size*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_filename**(*libsmdev\_handle\_t \*handle*, *char \*filename*, *size\_t filename\_size*, *libsmdev\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

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

*int*\

**libsmdev\_handle\_get\_filename\_size\_wide**(*libsmdev\_handle\_t \*handle*, *size\_t \*filename\_size*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_filename\_wide**(*libsmdev\_handle\_t \*handle*, *wchar\_t \*filename*, *size\_t filename\_size*, *libsmdev\_error\_t \*\*error*);

Meta data functions

*int*\

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

*int*\

**libsmdev\_handle\_get\_bytes\_per\_sector**(*libsmdev\_handle\_t \*handle*, *uint32\_t \*bytes\_per\_sector*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_media\_type**(*libsmdev\_handle\_t \*handle*, *uint8\_t \*media\_type*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_bus\_type**(*libsmdev\_handle\_t \*handle*, *uint8\_t \*bus\_type*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_utf8\_information\_value**(*libsmdev\_handle\_t \*handle*, *const uint8\_t \*identifier*, *size\_t identifier\_length*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_utf16\_information\_value**(*libsmdev\_handle\_t \*handle*, *const uint8\_t \*identifier*, *size\_t identifier\_length*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_number\_of\_sessions**(*libsmdev\_handle\_t \*handle*, *int \*number\_of\_sessions*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_session**(*libsmdev\_handle\_t \*handle*, *int index*, *uint64\_t \*start\_sector*, *uint64\_t \*number\_of\_sectors*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_number\_of\_tracks**(*libsmdev\_handle\_t \*handle*, *int \*number\_of\_tracks*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_track**(*libsmdev\_handle\_t \*handle*, *int index*, *uint64\_t \*start\_sector*, *uint64\_t \*number\_of\_sectors*, *uint8\_t \*type*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_number\_of\_error\_retries**(*libsmdev\_handle\_t \*handle*, *uint8\_t \*number\_of\_error\_retries*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_set\_number\_of\_error\_retries**(*libsmdev\_handle\_t \*handle*, *uint8\_t number\_of\_error\_retries*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_error\_granularity**(*libsmdev\_handle\_t \*handle*, *size\_t \*error\_granularity*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_set\_error\_granularity**(*libsmdev\_handle\_t \*handle*, *size\_t error\_granularity*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_error\_flags**(*libsmdev\_handle\_t \*handle*, *uint8\_t \*error\_flags*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_set\_error\_flags**(*libsmdev\_handle\_t \*handle*, *uint8\_t error\_flags*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_number\_of\_errors**(*libsmdev\_handle\_t \*handle*, *int \*number\_of\_errors*, *libsmdev\_error\_t \*\*error*);

*int*\

**libsmdev\_handle\_get\_error**(*libsmdev\_handle\_t \*handle*, *int index*, *off64\_t \*offset*, *size64\_t \*size*, *libsmdev\_error\_t \*\*error*);

## DESCRIPTION

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

## ENVIRONMENT

None

## FILES

None

## NOTES

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

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

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

## BUGS

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

## AUTHOR

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

## COPYRIGHT

Copyright (C) 2010-2019, 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 libsmdev.h include file