Marques pages
Se connecterINTRODUCTION
L’API StarSafe comprend, à aujourd’hui, 2 fonctions :
- SFGetDocument qui permet de récupérer de 0 à n documents en réponse à un ou plusieurs critères de recherche
- SFGetOneDocument qui ne retourne qu’un seul document au maximum en réponse à un ou plusieurs critères de recherche. Si plusieurs réponses, seul le 1er document sera retourné !
SFGetDocument
SFGetDocument permet de récupérer de 0 à n documents en réponse à un ou plusieurs critères de recherche
SFCUSTOM_API(int) SFGetDocument( char *NomArchive, char *Login, char *sCritereRecherche, char *RepertoireOuEcrireFichier, int NombreMaximumDeDocumentARetourner, char*RetourDuNomFichierSortieGenere ) ;
Les paramètres de cette fonction sont les suivants :
Le nom de l’archive dans laquelle la recherche sera faite. Le paramètre est de type char* Un identifiant qui sera utilisé dans la génération du nom du fichier PDF en sortie. Le paramètre est de type char*
Le ou les critères de recherche sous forme d’une chaine de caractères de valeur(s) séparée(s) par le caractère « ; ». Le paramètre est de type char*. Les valeurs sont placées dans l’ordre de
définition des index de l’archive.
Exemple : Liste des index de l’archive
Matricule
Nom
Periode
Agence
Date_Bulletin
Recherche par nom et agence, la chaine sera : « ;MR X ;;025; »
Chemin complet du répertoire où sera généré le fichier PDF. Le paramètre est de type char* Le nombre maximum de document(s) que la fonction doit retourner en cas de nombreuses
réponses au(x) critère(s) passé(s). Le paramètre est de type entier
Variable dans laquelle l’API retournera le nom du fichier PDF généré. Le paramètre est de
type char*
La fonction retourne un entier indiquant soit une erreur ( valeur <= 0 ) soit le nombre de documents trouvés.
SFGetOneDocument
SFGetOneDocument ne retourne qu’un seul document au maximum en réponse à un ou plusieurs critères de recherche. Si plusieurs réponses, seul le 1er document sera retourné !
SFCUSTOM_API(int) SFGetOneDocument( char * NomArchive, char * Login, char * sCritereRecherche, char * RepertoireOuEcrireFichier, char * RetourDuNomFichierSortieGenere) ;
Les paramètres de cette fonction sont les suivants :
Le nom de l’archive dans laquelle la recherche sera faite. Le paramètre est de type char* Un identifiant qui sera utilisé dans la génération du nom du fichier PDF en sortie. Le paramètre est de type char*
Le ou les critères de recherche sous forme d’une chaine de caractères de valeur(s) séparée(s)
par le caractère « ; ». Le paramètre est de type char*. Les valeurs sont placées dans l’ordre de définition des index de l’archive
Exemple : Liste des index de l’archive
Matricule
Nom
Periode
Agence
Date_Bulletin
Recherche par nom et agence, la chaine sera : « ;MR X ;;025; »
Chemin complet du répertoire où sera généré le fichier PDF. Le paramètre est de type char*
Variable dans laquelle l’API retournera le nom du fichier PDF généré. Le paramètre est de
type char*
La fonction retourne un entier indiquant soit une erreur ( valeur <= 0 ) soit le nombre de documents trouvés.
Exporter en PDF
Modifier l’article