pi_file Struct Reference

#include <pi-file.h>

Collaboration diagram for pi_file:

Collaboration graph
[legend]

Detailed Description

Definition at line 64 of file pi-file.h.

Data Fields

int err
int for_writing
int app_info_size
int sort_info_size
int next_record_list_id
int resource_flag
int ent_hdr_size
int num_entries
int num_entries_allocated
int rbuf_size
FILE * f
pi_buffer_ttmpbuf
char * file_name
void * app_info
void * sort_info
void * rbuf
unsigned long unique_id_seed
DBInfo info
pi_file_entryentries


Field Documentation

int pi_file::err

Definition at line 65 of file pi-file.h.

Referenced by pi_file_append_record(), pi_file_append_resource(), and pi_file_close().

int pi_file::for_writing

Non-zero if the file was opened with pi_file_create()

Definition at line 66 of file pi-file.h.

Referenced by pi_file_append_record(), pi_file_append_resource(), pi_file_close(), pi_file_create(), pi_file_read_record(), pi_file_read_resource(), and pi_file_set_info().

int pi_file::app_info_size

Size of the appInfo block

Definition at line 67 of file pi-file.h.

Referenced by pi_file_close_for_write(), pi_file_get_app_info(), pi_file_install(), pi_file_merge(), pi_file_open(), and pi_file_set_app_info().

int pi_file::sort_info_size

Size of the sortInfo block

Definition at line 68 of file pi-file.h.

Referenced by pi_file_close_for_write(), pi_file_get_sort_info(), pi_file_open(), and pi_file_set_sort_info().

int pi_file::next_record_list_id

Definition at line 69 of file pi-file.h.

Referenced by pi_file_close_for_write(), and pi_file_open().

int pi_file::resource_flag

Definition at line 70 of file pi-file.h.

Referenced by pi_file_append_record(), pi_file_append_resource(), pi_file_close_for_write(), pi_file_create(), pi_file_find_resource_by_type_id(), pi_file_open(), pi_file_read_record(), and pi_file_read_resource().

int pi_file::ent_hdr_size

Size of the header for each resource/record (depends on whether the file is a resource or record file)

Definition at line 71 of file pi-file.h.

Referenced by pi_file_close_for_write(), pi_file_create(), pi_file_install(), pi_file_merge(), and pi_file_open().

int pi_file::num_entries

Number of actual entries in the entries memory block

Definition at line 72 of file pi-file.h.

Referenced by pi_file_append_entry(), pi_file_close_for_write(), pi_file_get_entries(), pi_file_install(), pi_file_merge(), pi_file_open(), pi_file_read_record(), and pi_file_read_resource().

int pi_file::num_entries_allocated

Number of entries allocated in the entries memory block

Definition at line 73 of file pi-file.h.

Referenced by pi_file_append_entry().

int pi_file::rbuf_size

Size of the internal read buffer

Definition at line 74 of file pi-file.h.

Referenced by pi_file_set_rbuf_size().

FILE* pi_file::f

Actual on-disk file

Definition at line 75 of file pi-file.h.

Referenced by main(), palm_backup(), palm_fetch_internal(), palm_install_internal(), palm_merge(), palm_restore(), pi_file_free(), pi_file_open(), pi_file_read_record(), pi_file_read_resource(), and pi_file_retrieve_VFS().

pi_buffer_t* pi_file::tmpbuf

Temporary buffer for databases opened with pi_file_create()

Definition at line 76 of file pi-file.h.

Referenced by pi_file_append_record(), pi_file_append_resource(), pi_file_close_for_write(), pi_file_create(), and pi_file_free().

char* pi_file::file_name

Access path

Definition at line 77 of file pi-file.h.

Referenced by palm_install_internal(), pi_file_close_for_write(), pi_file_create(), and pi_file_free().

void* pi_file::app_info

Pointer to the appInfo block or NULL

Definition at line 78 of file pi-file.h.

Referenced by pi_file_close_for_write(), pi_file_free(), pi_file_get_app_info(), pi_file_open(), and pi_file_set_app_info().

void* pi_file::sort_info

Pointer to the sortInfo block or NULL

Definition at line 79 of file pi-file.h.

Referenced by pi_file_close_for_write(), pi_file_free(), pi_file_get_sort_info(), pi_file_open(), and pi_file_set_sort_info().

void* pi_file::rbuf

Read buffer, used internally

Definition at line 80 of file pi-file.h.

Referenced by pi_file_free(), pi_file_read_record(), pi_file_read_resource(), and pi_file_set_rbuf_size().

unsigned long pi_file::unique_id_seed

Database file's unique ID seed as read from an existing file

Definition at line 81 of file pi-file.h.

Referenced by pi_file_close_for_write(), and pi_file_open().

struct DBInfo pi_file::info

Database information and attributes

Definition at line 82 of file pi-file.h.

Referenced by fetch_remote_file(), palm_fetch_internal(), pi_file_close_for_write(), pi_file_create(), pi_file_get_info(), pi_file_install(), pi_file_merge(), pi_file_open(), pi_file_retrieve(), and pi_file_set_info().

struct pi_file_entry* pi_file::entries

Array of records / resources

Definition at line 83 of file pi-file.h.

Referenced by pi_file_append_entry(), pi_file_close_for_write(), pi_file_find_resource_by_type_id(), pi_file_free(), pi_file_id_used(), pi_file_open(), pi_file_read_record(), pi_file_read_record_by_id(), and pi_file_read_resource().


The documentation for this struct was generated from the following file:
© 1996-2007 by pilot-link.org. All rights reserved.