GCabFile

GCabFile — A file contained in the Cabinet

Stability Level

Stable, unless otherwise indicated

Synopsis

#include <libgcab.h>

gboolean            (*GCabFileCallback)                 (GCabFile *file,
                                                         gpointer user_data);
                    GCabFile;
GCabFile *          gcab_file_new_with_file             (const gchar *name,
                                                         GFile *file);
GFile *             gcab_file_get_file                  (GCabFile *file);
const gchar *       gcab_file_get_name                  (GCabFile *file);
const gchar *       gcab_file_get_extract_name          (GCabFile *file);
void                gcab_file_set_extract_name          (GCabFile *file,
                                                         const gchar *name);

Object Hierarchy

  GObject
   +----GCabFile

Properties

  "file"                     GFile*                : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct Only

Description

A GCabFile is a handle to a file inside a Cabinet archive. It can either be a file that is already within an exisiting archive, or a file that reference a file on disk that will be used for a new archive creation. In the later case, gcab_file_get_file() must return a valid handle.

Details

GCabFileCallback ()

gboolean            (*GCabFileCallback)                 (GCabFile *file,
                                                         gpointer user_data);

The type used for callback called when processing Cabinet archive files.

file :

the file being processed

user_data :

user data passed to the callback.

GCabFile

typedef struct _GCabFile GCabFile;

An opaque object, referencing a file in a Cabinet.


gcab_file_new_with_file ()

GCabFile *          gcab_file_new_with_file             (const gchar *name,
                                                         GFile *file);

Create a GCabFile from a given GFile, to be added to a GCabCabinet for archive creation.

name :

name of the file within the cabinet

file :

a GFile to be added to the cabinet

Returns :

a new GCabFile

gcab_file_get_file ()

GFile *             gcab_file_get_file                  (GCabFile *file);

If the cabinet is being created, get the GFile associated with file. This must be an exisiting file that can be read, in order to be added to the archive during cabinet creation.

If file is from an existing cabinet, the fuction will return NULL.

file :

a GCabFile

Returns :

the associated GFile or NULL. [transfer full]

gcab_file_get_name ()

const gchar *       gcab_file_get_name                  (GCabFile *file);

Get the file name within the cabinet.

file :

a GCabFile

Returns :

the cabinet file name

gcab_file_get_extract_name ()

const gchar *       gcab_file_get_extract_name          (GCabFile *file);

Get the file name to use for extraction, or NULL.

file :

a GCabFile

Returns :

a file name. [allow-none]

gcab_file_set_extract_name ()

void                gcab_file_set_extract_name          (GCabFile *file,
                                                         const gchar *name);

Sets the file name to use for extraction, instead of the name provided by the Cabinet.

file :

a GCabFile

name :

a file name or NULL. [allow-none]

Property Details

The "file" property

  "file"                     GFile*                : Read / Write / Construct Only

file.


The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

name.

Default value: NULL

See Also

GCabFolder