nntpgrab_plugin_unpack.h File Reference

#include "nntpgrab_plugin_base.h"

Go to the source code of this file.

Data Structures
struct	_plugin_unpack_imported_funcs
Typedefs
typedef struct _plugin_unpack_imported_funcs	PluginUnpackImportedFuncs
Functions
gboolean	nntpgrab_plugin_unpack_initialize (PluginUnpackImportedFuncs funcs)
	Initialize the plugin.
int	nntpgrab_plugin_unpack_get_version (void)
	Return the API version of the plugin.
gboolean	nntpgrab_plugin_unpack_do_unpack (const char *filename, const char *target_directory, char **errmsg)
	Unpack a file and save it in the given directory.

---

Typedef Documentation

typedef struct _plugin_unpack_imported_funcs PluginUnpackImportedFuncs

---

Function Documentation

gboolean nntpgrab_plugin_unpack_do_unpack	(	const char *	filename,
		const char *	target_directory,
		char **	errmsg
	)

Unpack a file and save it in the given directory.

• filename Filename of the file which needs to be extracted
• target_directory Directory to save the decode file in
• errmsg If the decode fails, an error message will be put here

Returns:

The result of the decode process

int nntpgrab_plugin_unpack_get_version

(

void

)

Return the API version of the plugin.

This is used to verify that the plugin is compatible with the interface the NNTPGrab Core expects

Returns:

NNTPGRAB_PLUGIN_API_VERSION

gboolean nntpgrab_plugin_unpack_initialize

(

PluginUnpackImportedFuncs

funcs

)

Initialize the plugin.

• funcs A structure containing all the callback functions the plugin can call to notify the NNTPGrab Core

Returns:

TRUE when the initialization was successfull

---