ODBC API-referencia

A következőkre vonatkozik:SQL Server Azure SQL Database Azure SQL Managed Instance

Az ODBC API szabványos függvénykészletet biztosít az adatforrásokhoz való csatlakozáshoz, az SQL-utasítások végrehajtásához és az eredmények lekéréséhez. Minden függvény egy C programozási nyelvi függvény, amelynek leírásában szerepel a cél, az ODBC verziója, a szintaxis, az argumentumok, a visszaadott értékek, a diagnosztikák és a kód példák.

A szabványos CLI-megfelelőségi szint az alábbiak egyike lehet: ISO 92, Open Group, ODBC vagy Elavult. Egy ISO 92-konformánsként megjelölt függvény is megjelenik az Open Group 1-es verziójában, mivel az Open Group az ISO 92 tiszta szuperhalmaza. Az ODBC 3.x-ben egy open group-kompatibilisként megjelölt függvény is megjelenik, mivel az ODBC 3.x az open group 1-es verziójának tiszta szuperhalmaza. Az ODBC-kompatibilisként megjelölt függvények egyik szabványban sem jelennek meg. Az elavultként megjelölt függvények elavultak az ODBC 3.x-ben.

Az SQLGetDiagField függvény leírása leírja, hogyan kezelhetők a diagnosztikai adatok. Az SQLSTATE-értékekhez társított szöveg tartalmazza a feltétel leírását, de nem ír elő konkrét szöveget.

Megjegyzés:

Az ODBC-függvényekkel kapcsolatos illesztőprogram-specifikus információkért tekintse meg az illesztőprogramról szóló szakaszt.

Foglalás és kezelés kezelése

Ezek a függvények lekérik és felszabadítják a környezetek, kapcsolatok, utasítások és leírók leíróit. A leírók az ODBC-alkalmazások állapotkövetési állapotának elsődleges mechanizmusai.

Funkció	Description
SQLAllocHandle	Lekért egy környezetet, kapcsolatot, utasítást vagy leíró leírót. Ez az ODBC 3.x függvény váltja fel az elavult foglalási függvényeket.
SQLFreeHandle	Felszabadít egy környezetet, kapcsolatot, utasítást vagy leírót, és felszabadítja a társított erőforrásokat.
SQLAllocConnect	Lekért egy kapcsolati leírót. Elavult az ODBC 3.x; helyett.`SQLAllocHandle`
SQLAllocEnv	Egy környezeti leírót foglal le. Elavult az ODBC 3.x; helyett.`SQLAllocHandle`
SQLAllocStmt	Egy utasításleírót foglal le. Elavult az ODBC 3.x; helyett.`SQLAllocHandle`
SQLFreeConnect	Felszabadít egy kapcsolati leírót. Elavult az ODBC 3.x; helyett.`SQLFreeHandle`
SQLFreeEnv	Felszabadít egy környezeti leírót. Elavult az ODBC 3.x; helyett.`SQLFreeHandle`
SQLFreeStmt	Leállítja az utasításfeldolgozást, bezárja a társított kurzorokat, elveti a függőben lévő eredményeket, és opcionálisan felszabadítja az utasításleíróhoz társított erőforrásokat.

Kapcsolati függvények

Ezek a függvények adatforrásokkal létesítenek és kezelnek kapcsolatokat. Különböző csatlakozási módszereket támogatnak, beleértve a standard kapcsolatokat, az illesztőprogram-specifikus párbeszédpaneleket és az iteratív böngészést.

Funkció	Description
SQLConnect	Adatforráshoz való csatlakozást hoz létre adatforrásnév, felhasználónév és jelszó használatával.
SQLDriverConnect	Kapcsolat létrehozása kapcsolati sztring használatával. Támogatja az illesztőprogram-specifikus párbeszédpaneleket további kapcsolati információkhoz.
SQLBrowseConnect	Iteratív módszert támogat az adatforráshoz való csatlakozáshoz szükséges attribútumok felderítésére és számbavételére.
SQLDisconnect	Bezár egy adatforráshoz való kapcsolatot, és felszabadítja a társított erőforrásokat.
SQLDataSources	Az elérhető adatforrások listáját adja vissza. Az Illesztőprogram-kezelőt hívta meg, nem egy adott illesztőprogramot.
SQLDrivers	A telepített illesztőprogramok és attribútumaik listáját adja vissza. Felhívta az illesztőprogram-kezelőt.

Utasítás előkészítése és végrehajtása

Ezek a függvények SQL-utasításokat készítenek elő és hajtanak végre. Az ODBC támogatja a közvetlen végrehajtást és az előkészített végrehajtást is, az előkészített végrehajtás pedig jobb teljesítményt nyújt az ismétlődően végrehajtott utasításokhoz.

Funkció	Description
SQLPrepare	SQL-utasítást készít a későbbi végrehajtáshoz. Az adatforrás lefordítja és optimalizálja az utasítást.
SQLExecute	Előkészített utasítást hajt végre. Hívás `SQLPrepare` a függvény meghívása előtt.
SQLExecDirect	Sql-utasítást készít elő és hajt végre egyetlen hívásban. Csak egyszer végrehajtott utasításokhoz használható.
SQLNativeSql	Az illesztőprogram által módosított SQL-sztringet adja vissza, amely azt mutatja, hogy az illesztőprogram hogyan fordítja le az ODBC SQL szintaxisát.
SQLCancel	Megszakítja a feldolgozást egy utasításon. Megszakíthat egy aszinkron módon végrehajtó függvényt vagy egy másik szálon futó függvényt.
SQLCancelHandle	Megszakítja a feldolgozást egy kapcsolaton vagy utasításon. Rugalmasabb, mint `SQLCancel` a kapcsolati függvények megszakítása.
SQLCompleteAsync	Meghatározza, hogy mikor fejeződik be egy aszinkron függvény. Értesítésalapú aszinkron feldolgozással használható.

Paraméterkötés

Ezek a függvények az alkalmazásváltozókat az SQL-utasítások paraméterjelölőihez kötik. A paraméterek dinamikus értékeket tesznek lehetővé az előkészített utasításokban.

Funkció	Description
SQLBindParameter	Az alkalmazásváltozót egy SQL-utasítás paraméterjelölőhöz köti. Támogatja a bemeneti, kimeneti és bemeneti/kimeneti paramétereket.
SQLNumParams	Egy SQL-utasítás paramétereinek számát adja vissza.
SQLDescribeParam	Egy paraméterjelölő leírását adja vissza, beleértve az adattípust, a méretet és a pontosságot.
SQLParamData	`SQLPutData` Paraméteradatok megadására szolgál a végrehajtási időpontban. Az adatokat igénylő paramétert adja vissza.
SQLPutData	Egy paraméter adatértékének egy részét vagy egészét küldi el a végrehajtási időpontban. Nagy adattömbökben való használatát támogatja.
SQLSetParam	Megköt egy paramétert. Elavult az ODBC 3.x; helyett.`SQLBindParameter`
SQLParamOptions	Paramétertömbök beállításainak megadása. Elavult az ODBC 3.x; utasításattribútumokat használjon.

Eredményhalmaz kötése és lekérése

Ezek a függvények az alkalmazáspuffereket az eredményhalmaz oszlopaihoz kötik, és adatokat kérnek le a lekérdezés eredményeiből.

Funkció	Description
SQLBindCol	Az alkalmazásváltozót egy eredményhalmaz-oszlophoz köti a későbbi beolvasási műveletekhez.
SQLFetch	Lekéri az eredményhalmaz következő adathalmazát kötött oszlopokba.
SQLFetchScroll	Lekéri a megadott sorhalmazt egy eredményhalmazból. Támogatja az első, az utolsó, a következő, az előző, az abszolút és a relatív pozíció közötti görgetést.
SQLGetData	Egyetlen oszlop adatait kéri le a következő után vagy `SQLFetchScroll`után`SQLFetch`. Nagy méretű adatokhoz vagy kötetlen oszlopokhoz hasznos.
SQLExtendedFetch	Beolvassa a megadott adatsorkészletet. Elavult az ODBC 3.x; helyett.`SQLFetchScroll`
SQLMoreResults	Meghatározza, hogy több eredmény érhető-e el egy utasításban, és továbblép-e a következő eredményhalmazra.
SQLRowCount	Az UPDATE, INSERT vagy DELETE utasítás által érintett sorok számát adja vissza.

Kurzorműveletek

Ezek a függvények kezelik a kurzor viselkedését, a pozicionálást és a sorokon végzett tömeges műveleteket.

Funkció	Description
SQLSetPos	Beállítja a kurzor pozícióját egy sorhalmazon belül, és lehetővé teszi az alkalmazások számára az adatok frissítését, frissítését vagy törlését ezen a helyen.
SQLBulkOperations	Tömeges beszúrási, frissítési, törlési vagy beolvasási műveleteket hajt végre a sorokon.
SQLCloseCursor	Bezár egy utasításon megnyitott kurzort, és elveti a függőben lévő eredményeket.
SQLGetCursorName	Az utasításhoz társított kurzornevet adja vissza.
SQLSetCursorName	A kurzor nevét adja meg a pozícióban lévő UPDATE és DELETE utasításokhoz.
SQLSetScrollOptions	A kurzor viselkedési beállításait adja meg. Elavult az ODBC 3.x; utasításattribútumokat használjon.

Katalógusfüggvények

Ezek a függvények metaadatokat kérnek le az adatbázis szerkezetéről, beleértve a táblákat, oszlopokat, indexeket, jogosultságokat és tárolt eljárásokat.

Funkció	Description
SQLTables	Az adatforrás táblaneveinek listáját adja vissza. A katalógus, séma és táblázattípus szerinti szűrést támogatja.
SQLColumns	A megadott táblák oszlopneveinek és attribútumainak listáját adja vissza.
SQLPrimaryKeys	A tábla elsődleges kulcsát alkotó oszlopokat adja vissza.
SQLForeignKeys	Idegen kulcsokat ad vissza egy táblában, vagy más táblákban lévő idegen kulcsokat, amelyek egy tábla elsődleges kulcsára hivatkoznak.
SQLStatistics	Egy táblára és a hozzá társított indexek listájára vonatkozó statisztikákat ad vissza.
SQLSpecialColumns	Olyan oszlopokat ad vissza, amelyek egyedileg azonosítják azokat a sorokat vagy oszlopokat, amelyek automatikusan frissülnek a sor bármely értékének frissítésekor.
SQLColumnPrivileges	Egy tábla oszlopainak és kapcsolódó jogosultságainak listáját adja vissza.
SQLTablePrivileges	A táblák listáját és az egyes táblákhoz társított jogosultságokat adja vissza.
SQLProcedures	Az adatforrásban tárolt eljárásnevek listáját adja vissza.
SQLProcedureColumns	A megadott eljárások eredményhalmazában szereplő bemeneti/kimeneti paraméterek és oszlopok listáját adja vissza.
SQLGetTypeInfo	Az adatforrás által támogatott adattípusok adatait adja vissza.

Leíró műveletek

Ezek a függvények lekérik és beállítják a leíró értékeket. A leírók metaadatokat tartalmaznak a paraméterekről és az eredményhalmaz oszlopairól.

Funkció	Description
SQLGetDescField	Egy leíró rekord egyetlen mezőjének értékét adja vissza.
SQLGetDescRec	Egy leíró rekord több mezőjét adja vissza egyetlen hívásban.
SQLSetDescField	Egy leíró rekord egyetlen mezőjének értékét állítja be.
SQLSetDescRec	Egy leíró rekord több mezőjét állítja be egyetlen hívásban.
SQLCopyDesc	Leíróadatok másolása egy leíró leíró leíróból egy másikba.

Attribútumfüggvények

Ezek a függvények lekérik és beállítják a környezetek, kapcsolatok és utasítások attribútumait. Az attribútumok az ODBC viselkedésének különböző aspektusait vezérli.

Funkció	Description
SQLSetEnvAttr	Beállít egy környezeti attribútumot, amely az adott környezet összes kapcsolatára hatással van.
SQLGetEnvAttr	Egy környezeti attribútum értékét adja vissza.
SQLSetConnectAttr	Beállít egy kapcsolatattribútumot, amely hatással van a kapcsolatra és a rajta lévő utasításokra.
SQLGetConnectAttr	Egy kapcsolatattribútum értékét adja vissza.
SQLSetStmtAttr	Beállít egy utasításattribútumot. Ide tartozik a kurzor, a lekérdezés időtúllépése és a paraméterbeállítások.
SQLGetStmtAttr	Egy utasításattribútum értékét adja vissza.
SQLSetConnectOption	Beállít egy kapcsolati beállítást. Elavult az ODBC 3.x; helyett.`SQLSetConnectAttr`
SQLGetConnectOption	Egy kapcsolati beállítás értékét adja vissza. Elavult az ODBC 3.x; helyett.`SQLGetConnectAttr`
SQLSetStmtOption	Beállít egy utasításbeállítást. Elavult az ODBC 3.x; helyett.`SQLSetStmtAttr`
SQLGetStmtOption	Egy utasítás beállítás értékét adja vissza. Elavult az ODBC 3.x; helyett.`SQLGetStmtAttr`

Diagnosztikai és információs függvények

Ezek a függvények diagnosztikai információkat, hibaüzeneteket, illesztőprogram-képességeket és adatforrás-információkat kérnek le.

Funkció	Description
SQLGetDiagField	Egy hiba-, figyelmeztetés- és állapotinformációkat tartalmazó diagnosztikai rekord egyik mezőjének értékét adja vissza.
SQLGetDiagRec	Egy diagnosztikai rekord számos gyakran használt mezőjét adja vissza, beleértve az SQLSTATE-t, a natív hibakódot és az üzenet szövegét.
SQLError	Hibainformációkat ad vissza. Elavult az ODBC 3.x; helyett.`SQLGetDiagRec`
SQLGetFunctions	Információt ad vissza arról, hogy egy illesztőprogram támogatja-e egy adott ODBC-függvényt.
SQLGetInfo	Általános információkat ad vissza az illesztőprogramról és az adatforrásról, beleértve a támogatott funkciókat és képességeket.

Eredményhalmaz metaadatai

Ezek a függvények az eredményhalmazok szerkezetére vonatkozó információkat ad vissza.

Funkció	Description
SQLNumResultCols	Az eredményhalmaz oszlopainak számát adja vissza.
SQLDescribeCol	Eredményhalmaz oszlopnevét, adattípusát, pontosságát, skálázását és nullképességét adja vissza.
SQLColAttribute	Eredményhalmaz oszlopainak leíró adatait adja vissza. Rugalmasabb, mint `SQLDescribeCol`a .
SQLColAttributes	Egy oszlop attribútumait adja vissza. Elavult az ODBC 3.x; helyett.`SQLColAttribute`

Tranzakciókezelés

Ezek a függvények kezelik a tranzakcióhatárokat, így szabályozhatók a módosítások véglegesítése vagy visszaállítása.

Funkció	Description
SQLEndTran	Véglegesít vagy visszaállít egy tranzakciót. Alkalmazható egy környezetben vagy egyetlen kapcsolaton lévő összes kapcsolatra.
SQLTransact	Véglegesít vagy visszaállít egy tranzakciót. Elavult az ODBC 3.x; helyett.`SQLEndTran`

Visszajelzés

Hasznosnak találta ezt az oldalt?

Last updated on 2026-02-10