Documentation de la bibliothèque Memory

Fonctions basiques

• int memory_createfile(char *adresse, int size);
• int memory_createdir (char *adresse);
• int memory_openfile(char *adresse, int mode);
• int memory_closefile(int handle);
• int memory_writefile(int handle, char *chaine, int length);
• int memory_readfile(int handle, void *buffer, int size, int pos);
• int memory_seekfile(int handle, int pos);
• int memory_filesize(int handle);
• int memory_deletefile (char *adresse);

Fonctions ajoutées

• char **memory_alloc(int l);
• void memory_free(char **p, int l);
• int  memory_find(char **files, char *adresse, int l)
• int  memory_exists(char *adresse);
• void *memory_load(char *adresse);
• void *memory_save(char *adresse, void *data, int l);

Fonctions utilisateur

• int  memory_user_select(char **files, int l, int extension);
• void *memory_user_autoload(char *prefix, char *selector, int l, int extension, int menu);

int memory_createfile(char *adresse, int size);

SYNOPSIS
Crée un fichier à l'adresse adresse et de size octets.

RETURN
Retourne la valeur de Bfile_CreateFile().

EXEMPLE
x = memory_createfile("\\\\fls0\\DOSSIER\\FICHIER.TXT",20);

int memory_createdir (char *adresse);

SYNOPSIS
Crée le répertoire à l'adresse adresse.

RETURN
Retourne la valeur de Bfile_CreateDirectory().

EXEMPLE
x = memory_createdir("\\\\fls0\\DOSSIER2");

int memory_openfile(char *adresse, int mode);

SYNOPSIS
Ouvre le fichier à l'adresse adresse en mode mode

RETURN
Retourne le handle de Bfile_OpenFile().

EXEMPLE
handle = memory_openfile("\\\\fls0\\DOSSIER\\FICHIER.TXT",_OPENMODE_READ);

int memory_closefile(int handle);

int memory_writefile(int handle, char *chaine, int length);

int memory_readfile(int handle, void *buffer, int size, int pos);

int memory_seekfile(int handle, int pos);

int memory_filesize(int handle);

SYNOPSIS
Ces cinq fonctions ne font qu'appeler leurs confrères de fxlib, avec les mêmes arguments.

RETURN
Retournent les valeurs respectives de Bfile_CloseFile(), Bfile_WriteFile(), Bfile_ReadFile(), Bfile_SeekFile() et Bfile_GetFileSize().

EXEMPLES
x = memory_closefile(handle);
x = memory_writefile(handle,maChaine,7);
memory_seekfile(handle,+12);
x = memory_readfile(handle,maChaine,7,-1);
size = memory_filesize(handle);

SYNOPSIS
Supprime le fichier à l'adresse adresse.

RETURN
Retourne la valeur de Bfile_DeleteFile().

EXEMPLE
x = memory_deletefile("\\\\fls0\\DOSSIER\\FICHIER.TXT");

char **memory_alloc(int l);

SYNOPSIS
Alloue la mémoire nécessaire pour effectuer une recherche de l éléments.

RETURN
Retourne le pointeur alloué.

EXEMPLE
char **files = memory_alloc(20);

void memory_free(char **p, int l);

SYNOPSIS
Libère le pointeur alloué pour une recherche de l éléments. Attention à bien entrer la valeur utilisée pour l'allocation.

RETURN
Ne retourne aucune valeur.

EXEMPLE
memory_free(files,20);

int memory_find(char **files, char *adresse, int l)

SYNOPSIS
Effectue une recherche de fichiers. La syntaxe des adresses est la même que pour les fonctions de fxlib.
Les fichiers correspondant à l'adresse adresse seront placés en liste au pointeur files, jusqu'à ce que le maximum de l éléments soit atteint.

RETURN
Retourne le nombre de fichiers trouvés.

EXEMPLE
char **files = memory_alloc(20);
int x = memory_find("\\\\crd0\\*BYTES",files,20);
x = memory_user_select(files,x,1);
memory_free(files,20);

int memory_exists(char *adresse);

SYNOPSIS
Indique si le fichier à l'adresse adresse existe.
Cette fonction est "relativement" lente puisqu'elle fait appel à memory_find().

RETURN
Retourne 1 si le fichier existe, 0 sinon.

EXEMPLE
if(memory_exists("\\\\fls0\\DOSSIER\\FICHIER.EXT")) memory_deletefile("\\\\fls0\\DOSSIER\\FICHIER.EXT");

void *memory_load(char *adresse);

SYNOPSIS
Charge un fichier de la mémoire.

RETURN
Retourne un pointeur pointant sur le contenu du fichier si le chargement a réussi, NULL sinon.

EXEMPLE
unsigned char *p = memory_load("\\\\fls0\\RECORDS.TXT");

void *memory_save(char *adresse, void *data, int l);

SYNOPSIS
Sauvegarde les données dans un fichier. Celui-ci est créé s'il n'existe pas, ouvert puis fermé. Il n'y a donc rien à gérer dans le programme appelant.

RETURN
Retourne la valeur d'erreur de la première erreur rencontrée.

EXEMPLE
char ch[20];
sprintf(ch,"%3d%3d%3d",1,483,43);
memory_save("\\\\crd0\\SAVE.SAV",ch,12);

int memory_user_select(char **files, int l, int extension, int exit);

SYNOPSIS
Interface simple de chargement de fichiers. files est le pointeur contenant la liste des fichiers, l est le nombre de fichiers dans la liste et extension indique si la fonction doit (1) ou non (0) afficher les extensions des fichiers (si il y en a).
La liste de des fichiers peut être celle obtenue par memory_find(). Dans ce cas, l doit être la valeur retournée par memory_find().
Le paramètre exit permet de définir si l'utilisateur peut (1) ou non (0) annuler le choix avec [EXIT].

RETURN
Retourne l'index du fichier choisi dans la liste, -1 si l'utilisateur quitte avec [EXIT].

EXEMPLE
char **files = memory_alloc(20);
int x = memory_find("\\\\crd0\\*BYTES",files,20);
x = memory_user_select(files,x,1);
memory_free(files,20);

void *memory_user_autoload(char *prefix, char *selector, int l, int extension, int exit);

SYNOPSIS
Fonction de chargement automatique de fichiers. Équivalent à une fusion entre memory_user_select() et memory_load(). Le paramètre prefix est le répertoire de recherche, selector est le critère de recherche, et l est le nombre maximum d'éléments qui seront trouvés. Les paramètres extension et exit indiquent, comme dans le cas de memory_user_select(), si les extensions des fichiers trouvés sont affichées et si l'utilisateur peut annuler le chargement en appuyant sur [EXIT].

RETURN
Renvoie un pointeur alloué sur les données chargées si le chargement a réussi, NULL s'il a échoué ou si l'utilisateur a quitté avec [EXIT].

EXEMPLE
unsigned char *data;
data = memory_user_autoload("\\\\crd0\\","*",20,1,0);
free(data);