Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of mappen te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen om mappen te wijzigen.
Van toepassing op:SQL Server
Azure SQL Database
Azure SQL Managed Instance
De ODBC-API biedt een standaardset functies voor het maken van verbinding met gegevensbronnen, het uitvoeren van SQL-instructies en het ophalen van resultaten. Elke functie is een C-programmeertaalfunctie met beschrijvingen die doel, ODBC-versie, syntaxis, argumenten, retourwaarden, diagnostische gegevens en codevoorbeelden bevatten.
Het standaard-CLI-nalevingsniveau kan een van de volgende zijn: ISO 92, Open Group, ODBC of Afgeschaft. Een functie die als ISO 92-conformant is gelabeld, wordt ook weergegeven in Open Group versie 1, omdat Open Group een pure superset van ISO 92 is. Een functie die is gelabeld als Open Group-compatibel, wordt ook weergegeven in ODBC 3.x, omdat ODBC 3.x een pure superset is van Open Group versie 1. Een functie die als ODBC-compatibel is getagd, wordt niet weergegeven in een van beide standaarden. Een functie die is gemarkeerd als afgeschaft, is afgeschaft in ODBC 3.x.
In de beschrijving van de functie SQLGetDiagField wordt beschreven hoe u diagnostische gegevens kunt verwerken. De tekst die aan SQLSTATE-waarden is gekoppeld, bevat een beschrijving van de voorwaarde, maar schrijft geen specifieke tekst voor.
Opmerking
Zie de sectie voor het stuurprogramma voor specifieke informatie over ODBC-functies.
Toewijzing en beheer verwerken
Deze functies wijzen en gratis ingangen toe voor omgevingen, verbindingen, instructies en descriptors. Handles zijn het primaire mechanisme voor het bijhouden van de status in ODBC-toepassingen.
| Functie | Description |
|---|---|
| SQLAllocHandle | Hiermee wijst u een omgeving, verbinding, instructie of descriptorgreep toe. Dit is de ODBC 3.x-functie die de afgeschafte toewijzingsfuncties vervangt. |
| SQLFreeHandle | Hiermee maakt u een omgeving, verbinding, instructie of descriptor-handle en releases van gekoppelde resources vrij. |
| SQLAllocConnect | Hiermee wijst u een verbindingsgreep toe. Afgeschaft in ODBC 3.x; gebruik SQLAllocHandle in plaats daarvan. |
| SQLAllocEnv | Hiermee wijst u een omgevingsgreep toe. Afgeschaft in ODBC 3.x; gebruik SQLAllocHandle in plaats daarvan. |
| SQLAllocStmt | Hiermee wijst u een instructiehandgreep toe. Afgeschaft in ODBC 3.x; gebruik SQLAllocHandle in plaats daarvan. |
| SQLFreeConnect | Hiermee wordt een verbindingsgreep vrijgemaakt. Afgeschaft in ODBC 3.x; gebruik SQLFreeHandle in plaats daarvan. |
| SQLFreeEnv | Hiermee wordt een omgevingsgreep vrijgemaakt. Afgeschaft in ODBC 3.x; gebruik SQLFreeHandle in plaats daarvan. |
| SQLFreeStmt | Stopt de verwerking van de instructie, sluit gekoppelde cursors, verwijdert wachtende resultaten en maakt eventueel resources vrij die zijn gekoppeld aan een instructiegreep. |
Verbindingsfuncties
Met deze functies worden verbindingen met gegevensbronnen tot stand gebracht en beheerd. Ze ondersteunen verschillende verbindingsmethoden, waaronder standaardverbindingen, stuurprogrammaspecifieke dialoogvensters en iteratieve navigatie.
| Functie | Description |
|---|---|
| SQLConnect | Hiermee maakt u een verbinding met een gegevensbron met behulp van een gegevensbronnaam, gebruikers-id en wachtwoord. |
| SQLDriverConnect | Hiermee maakt u een verbinding met behulp van een verbindingsreeks. Ondersteunt stuurprogrammaspecifieke dialoogvensters voor aanvullende verbindingsgegevens. |
| SQLBrowseConnect | Ondersteunt een iteratieve methode voor het detecteren en inventariseren van de kenmerken die nodig zijn om verbinding te maken met een gegevensbron. |
| SQLDisconnect | Hiermee sluit u een verbinding met een gegevensbron en worden gekoppelde resources vrijgegeven. |
| SQLDataSources | Retourneert een lijst met beschikbare gegevensbronnen. Belde de Driver Manager, geen specifiek stuurprogramma. |
| SQLDrivers | Retourneert een lijst met geïnstalleerde stuurprogramma's en hun kenmerken. Belde de Driver Manager. |
Voorbereiding en uitvoering van instructie
Met deze functies worden SQL-instructies voorbereid en uitgevoerd. ODBC ondersteunt zowel directe uitvoering als voorbereide uitvoering, met voorbereide uitvoering die betere prestaties biedt voor herhaaldelijk uitgevoerde instructies.
| Functie | Description |
|---|---|
| SQLPrepare | Bereidt een SQL-instructie voor op latere uitvoering. De gegevensbron compileert en optimaliseert de instructie. |
| SQLExecute | Voert een voorbereide instructie uit. Aanroepen SQLPrepare voordat u deze functie aanroept. |
| SQLExecDirect | Bereidt en voert een SQL-instructie uit in één aanroep. Gebruiken voor instructies die slechts één keer worden uitgevoerd. |
| SQLNativeSql | Retourneert de SQL-tekenreeks zoals gewijzigd door het stuurprogramma, waarin wordt getoond hoe het stuurprogramma ODBC SQL-syntaxis vertaalt. |
| SQLCancel | Annuleert de verwerking op een instructie. Kan een asynchrone uitvoering van een functie of een functie die wordt uitgevoerd op een andere thread annuleren. |
| SQLCancelHandle | Hiermee annuleert u de verwerking van een verbinding of instructie. Flexibeler dan SQLCancel voor het annuleren van verbindingsfuncties. |
| SQLCompleteAsync | Bepaalt wanneer een asynchrone functie is voltooid. Wordt gebruikt met asynchrone verwerking op basis van meldingen. |
Parameterbinding
Deze functies binden toepassingsvariabelen aan parametermarkeringen in SQL-instructies. Parameters maken dynamische waarden in voorbereide instructies mogelijk.
| Functie | Description |
|---|---|
| SQLBindParameter | Hiermee wordt een toepassingsvariabele gebonden aan een parametermarkering in een SQL-instructie. Ondersteunt invoer-, uitvoer- en invoer-/uitvoerparameters. |
| SQLNumParams | Retourneert het aantal parameters in een SQL-instructie. |
| SQLDescribeParam | Retourneert de beschrijving van een parametermarkering, inclusief gegevenstype, grootte en precisie. |
| SQLParamData | Wordt gebruikt om SQLPutData parametergegevens op te geven tijdens de uitvoering. Retourneert de parameter die gegevens nodig heeft. |
| SQLPutData | Hiermee verzendt u een deel of alle gegevenswaarde voor een parameter tijdens de uitvoering. Ondersteunt grote gegevens in segmenten. |
| SQLSetParam | Hiermee wordt een parameter gebonden. Afgeschaft in ODBC 3.x; gebruik SQLBindParameter in plaats daarvan. |
| SQLParamOptions | Hiermee stelt u opties voor parametermatrices in. Afgeschaft in ODBC 3.x; gebruik in plaats daarvan instructiekenmerken. |
Binding en ophalen van resultatenset
Deze functies binden toepassingsbuffers aan resultatensetkolommen en halen gegevens op uit queryresultaten.
| Functie | Description |
|---|---|
| SQLBindCol | Hiermee wordt een toepassingsvariabele gebonden aan een kolom met resultatensets voor volgende ophaalbewerkingen. |
| SQLFetch | Haalt de volgende rijenset met gegevens op uit de resultatenset in afhankelijke kolommen. |
| SQLFetchScroll | Haalt de opgegeven rijenset op uit een resultatenset. Ondersteunt schuiven naar de eerste, laatste, volgende, vorige, absolute en relatieve posities. |
| SQLGetData | Haalt gegevens op voor één kolom na SQLFetch of SQLFetchScroll. Handig voor grote gegevens of niet-afhankelijke kolommen. |
| SQLExtendedFetch | Haalt de opgegeven rijenset met gegevens op. Afgeschaft in ODBC 3.x; gebruik SQLFetchScroll in plaats daarvan. |
| SQLMoreResults | Bepaalt of er meer resultaten beschikbaar zijn op een instructie en naar de volgende resultatenset gaat. |
| SQLRowCount | Retourneert het aantal rijen dat wordt beïnvloed door de instructie UPDATE, INSERT of DELETE. |
Cursorbewerkingen
Deze functies beheren cursorgedrag, plaatsing en bulkbewerkingen voor rijensets.
| Functie | Description |
|---|---|
| SQLSetPos | Hiermee stelt u de cursorpositie in een rijset in en kunnen toepassingen gegevens op die positie vernieuwen, bijwerken of verwijderen. |
| SQLBulkOperations | Voert bulkbewerkingen voor invoegen, bijwerken, verwijderen of ophalen per bladwijzer uit op rijensets. |
| SQLCloseCursor | Hiermee sluit u een cursor die is geopend op een instructie en verwijdert u de resultaten die in behandeling zijn. |
| SQLGetCursorName | Retourneert de naam van de cursor die is gekoppeld aan een instructie. |
| SQLSetCursorName | Hiermee geeft u een cursornaam voor positioned UPDATE- en DELETE-instructies. |
| SQLSetScrollOptions | Hiermee stelt u opties voor cursorgedrag in. Afgeschaft in ODBC 3.x; gebruik in plaats daarvan instructiekenmerken. |
Catalogusfuncties
Met deze functies worden metagegevens opgehaald over de databasestructuur, waaronder tabellen, kolommen, indexen, bevoegdheden en opgeslagen procedures.
| Functie | Description |
|---|---|
| SQLTables | Retourneert een lijst met tabelnamen in de gegevensbron. Ondersteunt filteren op catalogus, schema en tabeltype. |
| SQLColumns | Retourneert een lijst met kolomnamen en hun kenmerken voor opgegeven tabellen. |
| SQLPrimaryKeys | Retourneert de kolommen waaruit de primaire sleutel voor een tabel bestaat. |
| SQLForeignKeys | Retourneert refererende sleutels in een tabel of refererende sleutels in andere tabellen die verwijzen naar de primaire sleutel van een tabel. |
| SQLStatistics | Retourneert statistieken over een tabel en een lijst met indexen die eraan zijn gekoppeld. |
| SQLSpecialColumns | Retourneert kolommen die een unieke identificatie vormen van een rij of kolommen die automatisch worden bijgewerkt wanneer een waarde in de rij wordt bijgewerkt. |
| SQLColumnPrivileges | Retourneert een lijst met kolommen en bijbehorende bevoegdheden voor een tabel. |
| SQLTablePrivileges | Retourneert een lijst met tabellen en de bevoegdheden die aan elke tabel zijn gekoppeld. |
| SQLProcedures | Retourneert een lijst met opgeslagen procedurenamen in de gegevensbron. |
| SQLProcedureColumns | Retourneert de lijst met invoer-/uitvoerparameters en -kolommen in de resultatenset voor opgegeven procedures. |
| SQLGetTypeInfo | Retourneert informatie over gegevenstypen die worden ondersteund door de gegevensbron. |
Descriptorbewerkingen
Met deze functies worden descriptorwaarden opgehaald en ingesteld. Descriptors bevatten metagegevens over parameters en kolommen in de resultatenset.
| Functie | Description |
|---|---|
| SQLGetDescField | Retourneert de waarde van één veld van een descriptorrecord. |
| SQLGetDescRec | Retourneert meerdere velden van een descriptorrecord in één aanroep. |
| SQLSetDescField | Hiermee stelt u de waarde van één veld van een descriptorrecord in. |
| SQLSetDescRec | Hiermee stelt u meerdere velden van een descriptorrecord in één aanroep in. |
| SQLCopyDesc | Kopieert descriptorgegevens van de ene descriptorgreep naar een andere. |
Kenmerkfuncties
Met deze functies worden kenmerken opgehaald en ingesteld voor omgevingen, verbindingen en instructies. Kenmerken bepalen verschillende aspecten van ODBC-gedrag.
| Functie | Description |
|---|---|
| SQLSetEnvAttr | Hiermee stelt u een omgevingskenmerk in dat van invloed is op alle verbindingen in die omgeving. |
| SQLGetEnvAttr | Retourneert de waarde van een omgevingskenmerk. |
| SQLSetConnectAttr | Hiermee stelt u een verbindingskenmerk in dat van invloed is op de verbinding en instructies. |
| SQLGetConnectAttr | Retourneert de waarde van een verbindingskenmerk. |
| SQLSetStmtAttr | Hiermee stelt u een instructiekenmerk in. Bevat cursor-, time-out- en parameterinstellingen. |
| SQLGetStmtAttr | Retourneert de waarde van een instructiekenmerk. |
| SQLSetConnectOption | Hiermee stelt u een verbindingsoptie in. Afgeschaft in ODBC 3.x; gebruik SQLSetConnectAttr in plaats daarvan. |
| SQLGetConnectOption | Retourneert de waarde van een verbindingsoptie. Afgeschaft in ODBC 3.x; gebruik SQLGetConnectAttr in plaats daarvan. |
| SQLSetStmtOption | Hiermee stelt u een instructieoptie in. Afgeschaft in ODBC 3.x; gebruik SQLSetStmtAttr in plaats daarvan. |
| SQLGetStmtOption | Retourneert de waarde van een instructieoptie. Afgeschaft in ODBC 3.x; gebruik SQLGetStmtAttr in plaats daarvan. |
Diagnostische en informatiefuncties
Met deze functies worden diagnostische gegevens, foutberichten, mogelijkheden van stuurprogramma's en gegevensbrongegevens opgehaald.
| Functie | Description |
|---|---|
| SQLGetDiagField | Retourneert de waarde van een veld in een diagnostische record met fout-, waarschuwings- en statusgegevens. |
| SQLGetDiagRec | Retourneert verschillende veelgebruikte velden van een diagnostische record, waaronder SQLSTATE, systeemeigen foutcode en berichttekst. |
| SQLError | Retourneert foutinformatie. Afgeschaft in ODBC 3.x; gebruik SQLGetDiagRec in plaats daarvan. |
| SQLGetFunctions | Retourneert informatie over of een stuurprogramma een specifieke ODBC-functie ondersteunt. |
| SQLGetInfo | Retourneert algemene informatie over het stuurprogramma en de gegevensbron, inclusief ondersteunde functies en mogelijkheden. |
Metagegevens van resultatenset
Deze functies retourneren informatie over de structuur van resultatensets.
| Functie | Description |
|---|---|
| SQLNumResultCols | Retourneert het aantal kolommen in een resultatenset. |
| SQLDescribeCol | Retourneert de kolomnaam, het gegevenstype, de precisie, de schaal en de null-waarde voor een kolom met resultatensets. |
| SQLColAttribute | Retourneert descriptorgegevens voor een kolom in een resultatenset. Flexibeler dan SQLDescribeCol. |
| SQLColAttributes | Retourneert kenmerken voor een kolom. Afgeschaft in ODBC 3.x; gebruik SQLColAttribute in plaats daarvan. |
Transactiebeheer
Deze functies beheren transactiegrenzen, bepalen wanneer wijzigingen worden doorgevoerd of teruggedraaid.
| Functie | Description |
|---|---|
| SQLEndTran | Een transactie doorvoert of terugdraait. Kan van toepassing zijn op alle verbindingen in een omgeving of één verbinding. |
| SQLTransact | Een transactie doorvoert of terugdraait. Afgeschaft in ODBC 3.x; gebruik SQLEndTran in plaats daarvan. |