SDK
Divers

Fonctions

int SPI_FIL_open_filcat (const std::string &dir, const std::string &pattern)
 Crée le catalogue des fichiers contenus dans un répertoire
et qui repondent au masque désiré
 
int SPI_FIL_get_filcat (std::string &fileName)
 Retourne le fichier courant du catalogue.
 
int SPI_FIL_get_size_filcat (double *fSize)
 Retourne la taille du fichier courant du catalogue.
 
int SPI_FIL_close_filcat ()
 Ferme le catalogue des fichiers.
 
int SPI_FIL_complet_name (const std::string &dirName, const std::string &fileName, std::string &fullName)
 Reconstitue un nom de fichier complet a partir de son nom et de son répertoire.
 
int SPI_FIL_delete_file (const std::string &dirName, const std::string &fileName)
 Supprime le fichier designé
 
int SPI_FIL_select_file (int mode, const std::string &ext, int flagMosaic, std::string &dir, std::string &name)
 Appelle du navigateur de fichier pour la sélection d'un fichier.
 
int SPI_FIL_test_file (const std::string &dirName, const std::string &fileName, int mode)
 Verifie la présence et les attributs d'un fichier ou d'un répertoire.
 
int SPI_FIL_copy_file (const std::string &dirIn, const std::string &filIn, const std::string &dirOut, const std::string &filOut)
 Copie un fichier.
 
int SPI_FIL_get_date_filcat (std::string &fDate)
 Retourne la date du fichier courant du catalogue.
 
int SPI_FIL_open_dircat (const std::string &dir, int mode)
 Crée le catalogue des sous-répertoires d'un répertoire.
 
int SPI_FIL_get_first_dircat (std::string &dir)
 Retourne le premier sous répertoire du catalogue.
 
int SPI_FIL_get_dircat (std::string &dir)
 Retourne le sous répertoire de 1er niveau du catalogue.
 
int SPI_FIL_close_dircat ()
 Ferme le catalogue des répertoires.
 
int SPI_FIL_base_name (const std::string &fullName, std::string &dirName, std::string &fileName)
 Décompose un nom de fichier complet en un nom de fichier et un nom de répertoire.
 
int SPI_FIL_new_extension (const std::string &fileIn, const std::string &ext, std::string &fileOut)
 Change l'extension du fichier.
 
int SPI_FIL_remove_extension (const std::string &fileIn, std::string &fileOut)
 Supprime l'extension du fichier.
 
int SPI_FIL_remove_tool_extension (const std::string &fileIn, std::string &fileOut)
 Supprime l'extension du fichier outil (si le nom est avec une extension outil)
 
int SPI_FIL_CompressDirToZip (const std::string &dirName, const std::string &zipFile)
 Crée un fichier zip avec tous les fichiers d'un répertoire.
 
int SPI_FIL_create_dir (const std::string &dirName)
 Crée un répertoire.
 
int SPI_FIL_delete_dir (const std::string &dirName)
 Supprime un répertoire.
 
int SPI_FIL_select_directory (std::string &folder)
 Appelle du navigateur de fichier pour la sélection d'un répertoire.
 
int SPI_FIL_get_extension (const std::string &fileName, std::string &ext)
 Récupère l'extension supposée d'un fichier.
 
int SPI_FIL_encrypt_file (const std::string &key, const std::string &dirName, const std::string &fileName)
 Crypte le fichier désigné
 
int SPI_FIL_decrypt_file (const std::string &key, const std::string &dirName, const std::string &fileName)
 Decrypte le fichier désigné
 

Description détaillée

Divers utilitaires pour la gestion des fichiers/répertoires

Documentation des fonctions

◆ SPI_FIL_base_name()

int SPI_FIL_base_name ( const std::string & fullName,
std::string & dirName,
std::string & fileName )

Décompose un nom de fichier complet en un nom de fichier et un nom de répertoire.

Version
4.4
Paramètres
[in]fullNamenom complet
[out]dirNamenom du répertoire
[out]fileNamenom du fichier
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_base_name,'c:\cni\goev4_5\iso\ruban.txt',dirname,
filename);
{ dirname = 'c:\cni\goev4_5\iso', filename = 'ruban.txt' }
int SPI_FIL_base_name(const std::string &fullName, std::string &dirName, std::string &fileName)
Décompose un nom de fichier complet en un nom de fichier et un nom de répertoire.
Definition sp_fil02.c:782

◆ SPI_FIL_close_dircat()

int SPI_FIL_close_dircat ( )

Ferme le catalogue des répertoires.

Version
4.4
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_close_dircat);
int SPI_FIL_close_dircat()
Ferme le catalogue des répertoires.
Definition sp_fil02.c:755
Voir également
SPI_FIL_open_dircat

◆ SPI_FIL_close_filcat()

int SPI_FIL_close_filcat ( )

Ferme le catalogue des fichiers.

Version
4.4
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_close_filcat);
int SPI_FIL_close_filcat()
Ferme le catalogue des fichiers.
Definition sp_fil02.c:343
Voir également
SPI_FIL_open_filcat

◆ SPI_FIL_complet_name()

int SPI_FIL_complet_name ( const std::string & dirName,
const std::string & fileName,
std::string & fullName )

Reconstitue un nom de fichier complet a partir de son nom et de son répertoire.

Version
4.4
Paramètres
[in]dirNamenom du répertoire
[in]fileNamenom du fichier
[out]fullNamenom complet
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_complet_name,'c:\GO2cam_intl\GO2camV607\iso','ruban.txt'
,full_name);
{ full_name = 'c:\GO2cam_intl\GO2camV607\iso\ruban.txt' }
int SPI_FIL_complet_name(const std::string &dirName, const std::string &fileName, std::string &fullName)
Reconstitue un nom de fichier complet a partir de son nom et de son répertoire.
Definition sp_fil02.c:370

◆ SPI_FIL_CompressDirToZip()

int SPI_FIL_CompressDirToZip ( const std::string & dirName,
const std::string & zipFile )

Crée un fichier zip avec tous les fichiers d'un répertoire.

Version
6.09
Paramètres
[in]dirNamenom du répertoire des fichiers
[in]zipFilenom complet du fichier zip à créer
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_CompressDirToZip,'c:\iso','c:\tmp\zipfile.z);
int SPI_FIL_CompressDirToZip(const std::string &dirName, const std::string &zipFile)
Crée un fichier zip avec tous les fichiers d'un répertoire.
Definition sp_fil02.c:930

◆ SPI_FIL_copy_file()

int SPI_FIL_copy_file ( const std::string & dirIn,
const std::string & filIn,
const std::string & dirOut,
const std::string & filOut )

Copie un fichier.

Version
4.4
Paramètres
[in]dirInnom du répertoire source
[in]filInnom du fichier source
[in]dirOutnom du répertoire destination
[in]filOutnom du fichier destination
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_copy_file,'c:\temp','ruban.txt','a:\','ruban.txt');
int SPI_FIL_copy_file(const std::string &dirIn, const std::string &filIn, const std::string &dirOut, const std::string &filOut)
Copie un fichier.
Definition sp_fil02.c:549

◆ SPI_FIL_create_dir()

int SPI_FIL_create_dir ( const std::string & dirName)

Crée un répertoire.

Version
4.4
Paramètres
[in]dirNamenom du répertoire
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_create_dir,'c:\temp\newdir');
int SPI_FIL_create_dir(const std::string &dirName)
Crée un répertoire.
Definition sp_fil02.c:960

◆ SPI_FIL_decrypt_file()

int SPI_FIL_decrypt_file ( const std::string & key,
const std::string & dirName,
const std::string & fileName )

Decrypte le fichier désigné

Version
5.9
Paramètres
[in]keycle de cryptage
[in]dirNamenom du répertoire
[in]fileNamenom du fichier
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_decrypt_file,'c:\temp','ruban.txt');
int SPI_FIL_decrypt_file(const std::string &key, const std::string &dirName, const std::string &fileName)
Decrypte le fichier désigné
Definition sp_fil02.c:1127

◆ SPI_FIL_delete_dir()

int SPI_FIL_delete_dir ( const std::string & dirName)

Supprime un répertoire.

Version
6.08
Paramètres
[in]dirNamenom du répertoire
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_delete_dir,'c:\temp\newdir');
int SPI_FIL_delete_dir(const std::string &dirName)
Supprime un répertoire.
Definition sp_fil02.c:988

◆ SPI_FIL_delete_file()

int SPI_FIL_delete_file ( const std::string & dirName,
const std::string & fileName )

Supprime le fichier designé

Version
4.4
Paramètres
[in]dirNamenom du répertoire
[in]fileNamenom du fichier
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_delete_file,'c:\temp','ruban.txt');
int SPI_FIL_delete_file(const std::string &dirName, const std::string &fileName)
Supprime le fichier designé
Definition sp_fil02.c:406

◆ SPI_FIL_encrypt_file()

int SPI_FIL_encrypt_file ( const std::string & key,
const std::string & dirName,
const std::string & fileName )

Crypte le fichier désigné

Version
5.9
Paramètres
[in]keyclé de cryptage
[in]dirNamenom du répertoire
[in]fileNamenom du fichier
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_encrypt_file,'c:\temp','ruban.txt');
int SPI_FIL_encrypt_file(const std::string &key, const std::string &dirName, const std::string &fileName)
Crypte le fichier désigné
Definition sp_fil02.c:1084

◆ SPI_FIL_get_date_filcat()

int SPI_FIL_get_date_filcat ( std::string & fDate)

Retourne la date du fichier courant du catalogue.

Version
4.4
Paramètres
[out]fDatedate du fichier (format:jj/mm/aa hh:mn)
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_get_date_filcat,date);
int SPI_FIL_get_date_filcat(std::string &fDate)
Retourne la date du fichier courant du catalogue.
Definition sp_fil02.c:590

◆ SPI_FIL_get_dircat()

int SPI_FIL_get_dircat ( std::string & dir)

Retourne le sous répertoire de 1er niveau du catalogue.

Version
4.4
Paramètres
[out]dirnom du répertoire
Un fichier nul signifie que la fin du catalogue est
atteinte
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_get_dircat,dir);
int SPI_FIL_get_dircat(std::string &dir)
Retourne le sous répertoire de 1er niveau du catalogue.
Definition sp_fil02.c:712

◆ SPI_FIL_get_extension()

int SPI_FIL_get_extension ( const std::string & fileName,
std::string & ext )

Récupère l'extension supposée d'un fichier.

Version
5.5
Paramètres
[in]fileNamenom du fichier
[out]extextension supposée

return SPI_YES

Pascal example
ier := ICALL(SPI_FIL_get_extension,'toto.txt',ext);
{ ext = 'txt' }
VB example
ier = GOE.SPI_FIL_get_extension("c:\tmp\toto.txt",ext)
'ext = "txt"
int SPI_FIL_get_extension(const std::string &fileName, std::string &ext)
Récupère l'extension supposée d'un fichier.
Definition sp_fil02.c:1046

◆ SPI_FIL_get_filcat()

int SPI_FIL_get_filcat ( std::string & fileName)

Retourne le fichier courant du catalogue.

Version
4.4
Paramètres
[out]fileNameNom du fichier
Un fichier nul signifie que la fin du catalogue est atteinte
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_get_filcat,filename);
int SPI_FIL_get_filcat(std::string &fileName)
Retourne le fichier courant du catalogue.
Definition sp_fil02.c:279

◆ SPI_FIL_get_first_dircat()

int SPI_FIL_get_first_dircat ( std::string & dir)

Retourne le premier sous répertoire du catalogue.

Version
4.4
Paramètres
[out]dirnom du répertoire
Un fichier nul signifie que la fin du catalogue est
atteinte
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_get_first_dircat,dir);
int SPI_FIL_get_first_dircat(std::string &dir)
Retourne le premier sous répertoire du catalogue.
Definition sp_fil02.c:673

◆ SPI_FIL_get_size_filcat()

int SPI_FIL_get_size_filcat ( double * fSize)

Retourne la taille du fichier courant du catalogue.

Version
4.4
Paramètres
[out]fSizetaille du fichier
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_get_size_filcat,size);
int SPI_FIL_get_size_filcat(double *fSize)
Retourne la taille du fichier courant du catalogue.
Definition sp_fil02.c:315

◆ SPI_FIL_new_extension()

int SPI_FIL_new_extension ( const std::string & fileIn,
const std::string & ext,
std::string & fileOut )

Change l'extension du fichier.

Version
4.4
Paramètres
[in]fileInancien nom du fichier
[in]extnouvelle extension
[out]fileOutnouveau nom de fichier
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_new_extension,'toto.txt','iso',newfile);
{ newfile = 'toto.iso' }
int SPI_FIL_new_extension(const std::string &fileIn, const std::string &ext, std::string &fileOut)
Change l'extension du fichier.
Definition sp_fil02.c:820

◆ SPI_FIL_open_dircat()

int SPI_FIL_open_dircat ( const std::string & dir,
int mode )

Crée le catalogue des sous-répertoires d'un répertoire.

Version
4.4
Paramètres
[in]dirnom du répertoire
[in]mode
  • SPI_FIL_CURR_CAT: catalogue de 1er niveau
  • SPI_FIL_TREE_CAT: catalogue recursif des répertoires
Renvoie
SPI_YES / SPI_NO
Remarques
Ne pas oublier de refermer le catalogue des répertoires
strcpy(dirname,'init');
ier := ICALL(SPI_FIL_open_dircat,'c:\cni\goev4_5\iso',SPI_FIL_CURR_CAT);
ier := ICALL (SPI_FIL_get_first_dircat,dirname);
WHILE ( dirname[0] <> chr(0) ) DO
BEGIN
ier := ICALL (SPI_FIL_get_dircat,dirname);
{ action with dirname }
END;
ier := ICALL(SPI_FIL_close_dircat);
int SPI_FIL_open_dircat(const std::string &dir, int mode)
Crée le catalogue des sous-répertoires d'un répertoire.
Definition sp_fil02.c:623
Voir également
SPI_FIL_close_dircat

◆ SPI_FIL_open_filcat()

int SPI_FIL_open_filcat ( const std::string & dir,
const std::string & pattern )

Crée le catalogue des fichiers contenus dans un répertoire
et qui repondent au masque désiré

Version
4.4
Paramètres
[in]dirnom du répertoire
[in]patternmasque pour la sélection des fichiers (defaut = *.*)
Exemple '*.PCE'
Renvoie
SPI_YES / SPI_NO
Remarques
Ne pas oublier de refermer le catalogue des fichiers
strcpy(name,'init');
ier := ICALL(SPI_FIL_open_filcat,'c:\temp','*.TXT');
WHILE ( name[0] <> chr(0) ) DO
BEGIN
ier := ICALL (SPI_FIL_get_filcat,name);
{ action with name }
END;
ier := ICALL(SPI_FIL_close_filcat);
int SPI_FIL_open_filcat(const std::string &dir, const std::string &pattern)
Crée le catalogue des fichiers contenus dans un répertoire et qui repondent au masque désiré
Definition sp_fil02.c:229
Voir également
SPI_FIL_close_filcat, SPI_FIL_get_filcat

◆ SPI_FIL_remove_extension()

int SPI_FIL_remove_extension ( const std::string & fileIn,
std::string & fileOut )

Supprime l'extension du fichier.

Version
6.05
Paramètres
[in]fileInancien nom du fichier
[out]fileOutnouveau nom de fichier
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_remove_extension,'toto.txt',newfile);
{ newfile = 'toto' }
int SPI_FIL_remove_extension(const std::string &fileIn, std::string &fileOut)
Supprime l'extension du fichier.
Definition sp_fil02.c:855

◆ SPI_FIL_remove_tool_extension()

int SPI_FIL_remove_tool_extension ( const std::string & fileIn,
std::string & fileOut )

Supprime l'extension du fichier outil (si le nom est avec une extension outil)

Version
6.08
Paramètres
[in]fileInancien nom du fichier
[out]fileOutnouveau nom de fichier
Renvoie
SPI_YES
ier := ICALL(SPI_FIL_remove_extension,'toto.F01',newfile);
{ newfile = 'toto' }
ier := ICALL(SPI_FIL_remove_extension,'toto_diam10.05',newfile);
{ newfile = 'toto_diam10.05' }

◆ SPI_FIL_select_directory()

int SPI_FIL_select_directory ( std::string & folder)

Appelle du navigateur de fichier pour la sélection d'un répertoire.

Version
4.4
Paramètres
[in,out]foldernom du répertoire
Renvoie
SPI_YES / SPI_NO
strcpy(dirname,'c\temp');
ier := ICALL(SPI_FIL_select_directory,dirname);
int SPI_FIL_select_directory(std::string &folder)
Appelle du navigateur de fichier pour la sélection d'un répertoire.
Definition sp_fil02.c:1016

◆ SPI_FIL_select_file()

int SPI_FIL_select_file ( int mode,
const std::string & ext,
int flagMosaic,
std::string & dir,
std::string & name )

Appelle du navigateur de fichier pour la sélection d'un fichier.

Version
4.4
Paramètres
[in]modeMode d'accès au fichier
  • 0: Lecture
  • 1: Ecriture
  • 2: Suppression
[in]extExtension du fichier
[in]flagMosaicAffichage de la mosaique (SPI_YES,SPI_NO)
[in,out]dirrépertoire du fichier
[in,out]namenom du fichier
Renvoie
SPI_YES / SPI_NO
strcpy(dirname,'c:\temp');
ier := ICALL(SPI_FIL_select_file,0,'TXT',SPI_YES,dirname,filename);
int SPI_FIL_select_file(int mode, const std::string &ext, int flagMosaic, std::string &dir, std::string &name)
Appelle du navigateur de fichier pour la sélection d'un fichier.
Definition sp_fil02.c:437

◆ SPI_FIL_test_file()

int SPI_FIL_test_file ( const std::string & dirName,
const std::string & fileName,
int mode )

Verifie la présence et les attributs d'un fichier ou d'un répertoire.

Version
4.4
Paramètres
[in]dirNamenom du répertoire
[in]fileNamenom du fichier
[in]mode
  • SPI_FIL_MODE_READ: accès en lecture du fichier
  • SPI_FIL_MODE_WRITE: accès en ecriture du fichier
  • SPI_DIR_MODE_READ: accès en lecture du répertoire
  • SPI_DIR_MODE_WRITE: accès en ecriture du répertoire
Renvoie
SPI_YES / SPI_NO
ier := ICALL(SPI_FIL_test_file,'c:\temp','ruban.txt',SPI_FIL_MODE_WRITE);
int SPI_FIL_test_file(const std::string &dirName, const std::string &fileName, int mode)
Verifie la présence et les attributs d'un fichier ou d'un répertoire.
Definition sp_fil02.c:490