NAME¶

libfplist.h — Library to support the plist formats

SYNOPSIS¶

#include <libfplist.h>

Support functions
const char *
libfplist_get_version(void);

Error functions
void
libfplist_error_free(libfplist_error_t **error);

int
libfplist_error_fprint(libfplist_error_t *error, FILE *stream);

int
libfplist_error_sprint(libfplist_error_t *error, char *string, size_t size);

int
libfplist_error_backtrace_fprint(libfplist_error_t *error, FILE *stream);

int
libfplist_error_backtrace_sprint(libfplist_error_t *error, char *string, size_t size);

Property list functions
int
libfplist_property_list_initialize(libfplist_property_list_t **property_list, libfplist_error_t **error);

int
libfplist_property_list_free(libfplist_property_list_t **property_list, libfplist_error_t **error);

int
libfplist_property_list_copy_from_byte_stream(libfplist_property_list_t *property_list, const uint8_t *byte_stream, size_t byte_stream_size, libfplist_error_t **error);

int
libfplist_property_list_has_plist_root_element(libfplist_property_list_t *property_list, libfplist_error_t **error);

int
libfplist_property_list_get_root_property(libfplist_property_list_t *property_list, libfplist_property_t **property, libfplist_error_t **error);

Property functions
int
libfplist_property_free(libfplist_property_t **property, libfplist_error_t **error);

int
libfplist_property_get_value_type(libfplist_property_t *property, int *value_type, libfplist_error_t **error);

int
libfplist_property_get_value_data_size(libfplist_property_t *property, size_t *data_size, libfplist_error_t **error);

int
libfplist_property_get_value_data(libfplist_property_t *property, uint8_t *data, size_t data_size, libfplist_error_t **error);

int
libfplist_property_get_value_integer(libfplist_property_t *property, uint64_t *value_64bit, libfplist_error_t **error);

int
libfplist_property_get_value_string(libfplist_property_t *property, uint8_t **string, size_t *string_size, libfplist_error_t **error);

int
libfplist_property_value_uuid_string_copy_to_byte_stream(libfplist_property_t *property, uint8_t *byte_stream, size_t byte_stream_size, libfplist_error_t **error);

int
libfplist_property_get_array_number_of_entries(libfplist_property_t *property, int *number_of_entries, libfplist_error_t **error);

int
libfplist_property_get_array_entry_by_index(libfplist_property_t *property, int array_entry_index, libfplist_property_t **array_entry, libfplist_error_t **error);

int
libfplist_property_get_sub_property_by_utf8_name(libfplist_property_t *property, const uint8_t *utf8_string, size_t utf8_string_length, libfplist_property_t **sub_property, libfplist_error_t **error);

DESCRIPTION¶

The libfplist_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 "libfplist.h".

ENVIRONMENT¶

None

FILES¶

None

BUGS¶

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

AUTHOR¶

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

COPYRIGHT¶

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