fvh2office/fvh2office.h fájlreferencia

Interface funkciók az FVH program és ügyfélnyilvántartó rendszerek közt. Részletek...

Ugrás a fájl forráskódjához.

Függvények

long __stdcall FI_Initialize (const char *user, const char *psw, const char *db_alias, long show_login_dlg, const char *xsd_file)
 Modul inicializálás.
long __stdcall FI_Terminate ()
 modul zárás, erőforrások szabadítása
long __stdcall FIWriteXmlStream (const char *filename, const char *xmldata, char **result)
 ügyfél és jármű törzsadatok rögzítése az FVH adatbázisban
long __stdcall FIReadXmlStream (const char *xml_type, const char *query_type, const char *query_param, char **xml_data)
 gépjármű és ügyfél adat(ok) lekérdezése
const char *__stdcall FIGetErrorText ()
 utolsó hibaszöveg lekérdezés

Részletes leírás

Interface funkciók az FVH program és ügyfélnyilvántartó rendszerek közt.

A modul használatára egy mintaprogram. 

#include "../fvh2office/fvh2office.h"
#include <stdio.h>

int main(int argC, char* argV[])
{
        char *xml;
        long retval;
        
        // Nem léptetjük be a felhasználót,
        retval = FI_Initialize("zk", "super", "zkkulso", 0, "http://www.3szs.hu/fvh2office/");
        if (FI_OK != retval)
        {
                fprintf(stdout, "Hiba történt inicializálás közben!\nHibakód: %i\nHibaszöveg:\n   %s\n",
                        retval, FIGetErrorText());
                return retval;
        }
        // A megadott paraméter szerint lekérdezzük az adott rendszámú autó-adatokat.
        retval = FIReadXmlStream("jarmuvek", "rendszam", argV[1], &xml);
        if (FI_OK != retval)
        {
                fprintf(stdout, "Hiba történt a rendszám szerinti lekérdezés közben!\nHibakód: %i\nHibaszöveg:\n   %s\n",
                        retval, FIGetErrorText());
                return retval;
        }
        // A kapott adatokat kiírjuk.
        fprintf(stdout, xml);
        // lezárjuk a kapcsolatot a fvhinf modullal.
        return FI_Terminate();
}

Függvények dokumentációja

long __stdcall FI_Initialize (  const char *  user,
const char *  psw,
const char *  db_alias,
long  show_login_dlg,
const char *  xsd_file
) 
 

Modul inicializálás.

Kötelető meghívni az első lekérdezés, vagy adatfeltöltés előtt. A hívás elmulasztása a FI_NOT_INITIALIZED hibát eredményezi a további funkciók használata esetén.

Paraméterek:
user felhasználónév vagy üres sztring
psw jelszó vagy üres sztring
db_alias adatbázis neve vagy üres sztring
show_login_dlg 
  • 0 esetén a fenti paraméterekkel fog a modul bejelentkezni az adatbázisba
  • 1 esetén a felhasználó adja meg a bejelentkezési adatokat
xsd_file az XML séma-definicíós állományok elérhetősége. Ez lehet lokális könyvtár, vagy URL is pl.: http://www.3szs.hu/fvh2office/
Visszatérési érték:
type_FI_error_codes
        long retval;
        char *xml;

        retval = FI_Initialize("tanúsítványadó", "zöldkártya", "zk", 0, "http://192.168.100.101/fvhport/");
        if (FI_OK == retval)
        {
                // .. futhat tovább a program
        }
        else
        {
                MessageBox(NULL, FIGetErrorText(), "HIBA", MB_OK);
                exit();
        }

long __stdcall FI_Terminate (   ) 
 

modul zárás, erőforrások szabadítása

Figyelmeztetés:
Kilépés előtt kötelező hívni!
Visszatérési érték:
type_FI_error_codes

const char* __stdcall FIGetErrorText (   ) 
 

utolsó hibaszöveg lekérdezés

Visszatérési érték:
hiba szövege

long __stdcall FIReadXmlStream (  const char *  xml_type,
const char *  query_type,
const char *  query_param,
char **  xml_data
) 
 

gépjármű és ügyfél adat(ok) lekérdezése

A funkció által visszadott adatok XML formátumúak, kivéve abban az esetben, ha kritikus rendszerhiba miatt nem jött létre a result paraméterben a válasz. Ebben az esetben a függvény visszatérési értéke nem lehet FI_OK
Példa a funkció használatára: 

        long retval;
        char *xml;

        // az összes ABC betűkkel kezdődő rendszámú autó adatainak lekérdezése
        retval = FIReadXmlStream("jarmuvek", "rendszam", "ABC", &xml);
        if (FI_OK == retval)
        {
                // xml adatok feldolgozása...
        }
        else
        {
                MessageBox(NULL, FIGetErrorText(), "HIBA", MB_OK);
        }
Paraméterek:
query_type lekérdezés típusa. Lehetséges értékek:
  • "rendszam": gépjármű rendszáma szerinti lekérdezés
  • "alvazszam": gépjármű alvázszáma szerinti lekérdezés
query_param lekérdezési paraméter, rendszám vagy alvázszám
xml_data xml adat-mutató, mely tartalmazza a lekérdezés eredménymutatóját. A következő hívás a puffer tartalmát felülírja, tehát további használat céljából le kell másolni a tartalmát.
xml_type lekérdezett állomány típusa. jelenleg két értéke lehet:
Visszatérési érték:
type_FI_error_codes

long __stdcall FIWriteXmlStream (  const char *  filename,
const char *  xmldata,
char **  result
) 
 

ügyfél és jármű törzsadatok rögzítése az FVH adatbázisban

A funkció az adatokat a Jármű adatok sémája szerinti szerkezetben várja, a választ a Adatbetöltés eredmény sémája szerint kapja vissza hívó.

Paraméterek:
filename xml állomány azonosítója
xmldata xml adatok
result xml formátumú eredmény
Visszatérési érték:
type_FI_error_codes

Projekt: Fvhxmlinterface - 0.6 Készült: 14 Oct 2005 Készítette:   3Sz-s Kft.