nntpgrab_plugin_decoder.h File Reference

#include "nntpgrab_plugin_base.h"
#include "collections.h"

Go to the source code of this file.

Data Structures
struct	_plugin_decoder_imported_funcs
Typedefs
typedef struct _plugin_decoder_imported_funcs	PluginDecoderImportedFuncs
Functions
gboolean	nntpgrab_plugin_decoder_initialize (PluginDecoderImportedFuncs funcs)
	Initialize the plugin.
int	nntpgrab_plugin_decoder_get_version (void)
	Return the API version of the plugin.
NNTPGrabDecoderRes	nntpgrab_plugin_decoder_decode_file (const char *collection_name, NNTPFile *file, const char *temp_directory, const char *target_directory, int *saved_errno, char **errmsg)
	Decode a NNTPFile* and save it in the given directory.

---

Typedef Documentation

typedef struct _plugin_decoder_imported_funcs PluginDecoderImportedFuncs

---

Function Documentation

NNTPGrabDecoderRes nntpgrab_plugin_decoder_decode_file	(	const char *	collection_name,
		NNTPFile *	file,
		const char *	temp_directory,
		const char *	target_directory,
		int *	saved_errno,
		char **	errmsg
	)

Decode a NNTPFile* and save it in the given directory.

• collection_name The name of the collection where this file belongs to
• file Structure containing the data which needs to be decoded
• temp_directory Where can all the parts be found?
• target_directory Directory to save the decode file in
• saved_errno In case of errors, the corresponding errno is saved here
• errmsg If the decode fails, an error message will be put here

Returns:

The result of the decode process

int nntpgrab_plugin_decoder_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_decoder_initialize

(

PluginDecoderImportedFuncs

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

---