NAME¶

libmdmp.h — Library to access the Windows Minidump (MDMP) format

SYNOPSIS¶

#include <libmdmp.h>

Support functions
const char *
libmdmp_get_version(void);

int
libmdmp_get_access_flags_read(void);

int
libmdmp_get_codepage(int *codepage, libmdmp_error_t **error);

int
libmdmp_set_codepage(int codepage, libmdmp_error_t **error);

int
libmdmp_check_file_signature(const char *filename, libmdmp_error_t **error);

Available when compiled with wide character string support:
int
libmdmp_check_file_signature_wide(const wchar_t *filename, libmdmp_error_t **error);

Available when compiled with libbfio support:
int
libmdmp_check_file_signature_file_io_handle(libbfio_handle_t *file_io_handle, libmdmp_error_t **error);

Notify functions
void
libmdmp_notify_set_verbose(int verbose);

int
libmdmp_notify_set_stream(FILE *stream, libmdmp_error_t **error);

int
libmdmp_notify_stream_open(const char *filename, libmdmp_error_t **error);

int
libmdmp_notify_stream_close(libmdmp_error_t **error);

Error functions
void
libmdmp_error_free(libmdmp_error_t **error);

int
libmdmp_error_fprint(libmdmp_error_t *error, FILE *stream);

int
libmdmp_error_sprint(libmdmp_error_t *error, char *string, size_t size);

int
libmdmp_error_backtrace_fprint(libmdmp_error_t *error, FILE *stream);

int
libmdmp_error_backtrace_sprint(libmdmp_error_t *error, char *string, size_t size);

File functions
int
libmdmp_file_initialize(libmdmp_file_t **file, libmdmp_error_t **error);

int
libmdmp_file_free(libmdmp_file_t **file, libmdmp_error_t **error);

int
libmdmp_file_signal_abort(libmdmp_file_t *file, libmdmp_error_t **error);

int
libmdmp_file_open(libmdmp_file_t *file, const char *filename, int access_flags, libmdmp_error_t **error);

int
libmdmp_file_close(libmdmp_file_t *file, libmdmp_error_t **error);

int
libmdmp_file_get_number_of_streams(libmdmp_file_t *file, int *number_of_streams, libmdmp_error_t **error);

int
libmdmp_file_get_stream(libmdmp_file_t *file, int stream_index, libmdmp_stream_t **stream, libmdmp_error_t **error);

int
libmdmp_file_get_stream_by_type(libmdmp_file_t *file, uint32_t stream_type, libmdmp_stream_t **stream, libmdmp_error_t **error);

Available when compiled with wide character string support:
int
libmdmp_file_open_wide(libmdmp_file_t *file, const wchar_t *filename, int access_flags, libmdmp_error_t **error);

Available when compiled with libbfio support:
int
libmdmp_file_open_file_io_handle(libmdmp_file_t *file, libbfio_handle_t *file_io_handle, int access_flags, libmdmp_error_t **error);

Stream functions
int
libmdmp_stream_free(libmdmp_stream_t **stream, libmdmp_error_t **error);

int
libmdmp_stream_get_type(libmdmp_stream_t *stream, uint32_t *type, libmdmp_error_t **error);

ssize_t
libmdmp_stream_read_buffer(libmdmp_stream_t *stream, void *buffer, size_t buffer_size, libmdmp_error_t **error);

ssize_t
libmdmp_stream_read_buffer_at_offset(libmdmp_stream_t *stream, void *buffer, size_t buffer_size, off64_t offset, libmdmp_error_t **error);

off64_t
libmdmp_stream_seek_offset(libmdmp_stream_t *stream, off64_t offset, int whence, libmdmp_error_t **error);

int
libmdmp_stream_get_offset(libmdmp_stream_t *stream, off64_t *offset, libmdmp_error_t **error);

int
libmdmp_stream_get_size(libmdmp_stream_t *stream, size64_t *size, libmdmp_error_t **error);

int
libmdmp_stream_get_start_offset(libmdmp_stream_t *stream, off64_t *start_offset, libmdmp_error_t **error);

int
libmdmp_stream_get_virtual_address(libmdmp_stream_t *stream, uint32_t *virtual_address, libmdmp_error_t **error);

Available when compiled with libbfio support:
int
libmdmp_stream_get_data_file_io_handle(libmdmp_stream_t *stream, libbfio_handle_t **file_io_handle, libmdmp_error_t **error);

DESCRIPTION¶

The libmdmp_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 "libmdmp.h".

ENVIRONMENT¶

None

FILES¶

None

NOTES¶

libmdmp can be compiled with wide character support (wchar_t).

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

LIBMDMP_WIDE_CHARACTER_TYPE
in libmdmp/features.h can be used to determine if libmdmp was compiled with wide character support.

BUGS¶

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

AUTHOR¶

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

COPYRIGHT¶

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