archive_plugin Struct Reference

#include <archive_api.h>

Data Fields

const char * name
bool(* init )(void)
 optional, set this to NULL if the archive plugin doesn't have/need one this must false if there is an error and true otherwise
void(* finish )(void)
 optional, set this to NULL if the archive plugin doesn't have/need one
struct archive_file *(* open )(char *pathname)
 tryes to open archive file and associates handle with archive returns pointer to handle used is all operations with this archive or NULL when opening fails
void(* scan_reset )(struct archive_file *)
 reset routine will move current read index in archive to default position and then the filenames from archives can be read via scan_next routine
char *(* scan_next )(struct archive_file *)
 the read method will return corresponding files from archive (as pathnames) and move read index to next file.
bool(* open_stream )(struct archive_file *, struct input_stream *is, const char *path)
 Opens an input_stream of a file within the archive.
void(* close )(struct archive_file *)
 closes archive file.
const char *const * suffixes
 suffixes handled by this plugin.

Detailed Description

Definition at line 36 of file archive_api.h.


Field Documentation

closes archive file.

Definition at line 87 of file archive_api.h.

void(* archive_plugin::finish)(void)

optional, set this to NULL if the archive plugin doesn't have/need one

Definition at line 50 of file archive_api.h.

bool(* archive_plugin::init)(void)

optional, set this to NULL if the archive plugin doesn't have/need one this must false if there is an error and true otherwise

Definition at line 44 of file archive_api.h.

const char* archive_plugin::name

Definition at line 37 of file archive_api.h.

struct archive_file*(* archive_plugin::open)(char *pathname) [read]

tryes to open archive file and associates handle with archive returns pointer to handle used is all operations with this archive or NULL when opening fails

Definition at line 57 of file archive_api.h.

bool(* archive_plugin::open_stream)(struct archive_file *, struct input_stream *is, const char *path)

Opens an input_stream of a file within the archive.

If this function succeeds, then the input_stream "owns" the archive file and will automatically close it.

Parameters:
path the path within the archive

Definition at line 81 of file archive_api.h.

the read method will return corresponding files from archive (as pathnames) and move read index to next file.

When there is no next file it return NULL.

Definition at line 71 of file archive_api.h.

reset routine will move current read index in archive to default position and then the filenames from archives can be read via scan_next routine

Definition at line 64 of file archive_api.h.

const char* const* archive_plugin::suffixes

suffixes handled by this plugin.

last element in these arrays must always be a NULL

Definition at line 93 of file archive_api.h.


The documentation for this struct was generated from the following file:
Generated on Sun May 2 21:28:32 2010 for MPD by  doxygen 1.6.3