SQLProcedures-Funktion

Konformität
Eingeführte Version: ODBC 1.0 Standards Compliance: ODBC

Zusammenfassung
SQLProcedures liefert die Liste der Prozedurnamen, die in einer bestimmten Datenquelle gespeichert sind. Verfahren ist ein generischer Begriff, der verwendet wird, um ein ausführbares Objekt oder eine benannte Entität zu beschreiben, die mithilfe von Eingabe- und Ausgabeparametern aufgerufen werden kann. Weitere Informationen zu den Verfahren finden Sie in den Verfahren.

Syntax

  
SQLRETURN SQLProcedures(  
     SQLHSTMT       StatementHandle,  
     SQLCHAR *      CatalogName,  
     SQLSMALLINT    NameLength1,  
     SQLCHAR *      SchemaName,  
     SQLSMALLINT    NameLength2,  
     SQLCHAR *      ProcName,  
     SQLSMALLINT    NameLength3);

Arguments

StatementHandle
[Eingabe] Anweisungshandle.

Catalogname
[Eingabe] Prozedurkatalog. Wenn ein Treiber Kataloge für einige Tabellen, aber nicht für andere unterstützt, etwa wenn der Treiber Daten aus verschiedenen DBMSs abruft, bezeichnet eine leere Zeichenkette ("") jene Tabellen, die keine Kataloge besitzen. CatalogName kann kein String-Suchmuster enthalten.

Wenn das Attribut SQL_ATTR_METADATA_ID Statement auf SQL_TRUE gesetzt ist, wird CatalogName als Identifikator behandelt und sein Fall ist nicht signifikant. Wenn es SQL_FALSE ist, ist CatalogName ein gewöhnliches Argument; Es wird wörtlich behandelt, und sein Fall ist bedeutsam. Weitere Informationen finden Sie unter Argumente in Katalogfunktionen.

NameLength1
[Eingabe] Länge in den Zeichen von *CatalogName.

SchemaName
[Eingabe] Zeichenkettensuchmuster für Prozedurschemanamen. Wenn ein Treiber Schemata für einige Prozeduren unterstützt, aber nicht für andere, etwa wenn der Treiber Daten aus verschiedenen DBMS abruft, bezeichnet eine leere Zeichenkette ("") jene Prozeduren, die keine Schemata besitzen.

Wenn das Attribut SQL_ATTR_METADATA_ID Statement auf SQL_TRUE gesetzt ist, wird SchemaName als Identifikator behandelt und sein Fall ist nicht signifikant. Wenn es SQL_FALSE ist, ist SchemaName ein Musterwert-Argument; Es wird wörtlich behandelt, und sein Fall ist bedeutsam.

NameLength2
[Eingabe] Länge in den Zeichen von *SchemaName.

ProcName
[Eingabe] String-Suchmuster für Prozedurnamen.

Wenn das Attribut SQL_ATTR_METADATA_ID Statement auf SQL_TRUE gesetzt ist, wird ProcName als Identifikator behandelt und sein Fall ist nicht signifikant. Wenn es SQL_FALSE ist, ist ProcName ein Musterwert-Argument; Es wird wörtlich behandelt, und sein Fall ist bedeutsam.

NameLength3
[Eingabe] Länge in den Zeichen von *ProcName.

Rückkehr

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR oder SQL_INVALID_HANDLE.

Diagnostics

Wenn SQLProcedures SQL_ERROR oder SQL_SUCCESS_WITH_INFO zurückgibt, kann ein zugehöriger SQLSTATE-Wert erhalten werden, indem SQLGetDiagRec mit einem HandleType von SQL_HANDLE_STMT und einem Handle von StatementHandle aufgerufen wird. Die folgende Tabelle listet die SQLSTATE-Werte auf, die häufig von SQLProcedures zurückgegeben werden, und erklärt jeden einzelnen im Kontext dieser Funktion; die Notation "(DM)" geht den vom Treibermanager zurückgegebenen SQLSTATE-Beschreibungen voraus. Der rückgabecode, der jedem SQLSTATE-Wert zugeordnet ist, ist SQL_ERROR, sofern nicht anders angegeben.

SQLSTATE Fehler Description
01000 Allgemeiner Warnhinweis Treiberspezifische Informationsmeldung. (Funktion gibt SQL_SUCCESS_WITH_INFO zurück.)
08S01 Kommunikationslinkfehler Die Kommunikationsverbindung zwischen dem Treiber und der Datenquelle, mit der der Treiber verbunden wurde, ist fehlgeschlagen, bevor die Verarbeitung der Funktion abgeschlossen wurde.
24000 Ungültiger Cursorstatus Ein Cursor war auf dem StatementHandle geöffnet, und SQLFetch oder SQLFetchScroll war aufgerufen worden. Dieser Fehler wird vom Treiber-Manager zurückgegeben, wenn SQLFetch oder SQLFetchScroll nicht SQL_NO_DATA zurückgegeben hat und vom Treiber zurückgegeben wird, wenn SQLFetch oder SQLFetchScroll SQL_NO_DATA zurückgegeben wurde.

Ein Cursor war auf dem StatementHandle geöffnet, aber SQLFetch oder SQLFetchScroll waren nicht aufgerufen worden.
40001 Serialisierungsfehler Die Transaktion wurde aufgrund eines Ressourcen-Deadlocks mit einer anderen Transaktion zurückgesetzt.
40003 Abschluss der Anweisung unbekannt Fehler bei der zugehörigen Verbindung während der Ausführung dieser Funktion, und der Status der Transaktion kann nicht bestimmt werden.
HY000 Allgemeiner Fehler Es ist ein Fehler aufgetreten, für den kein spezifischer SQLSTATE-Wert vorhanden war und für den keine implementierungsspezifische SQLSTATE definiert wurde. Die von SQLGetDiagRec im *MessageText-Puffer zurückgegebene Fehlermeldung beschreibt den Fehler und dessen Ursache.
HY001 Speicherzuweisungsfehler Der Treiber konnte speicher nicht zuordnen, der erforderlich ist, um die Ausführung oder den Abschluss der Funktion zu unterstützen.
HY008 Vorgang abgebrochen Die asynchrone Verarbeitung wurde für " StatementHandle" aktiviert. Die Funktion wurde aufgerufen, und bevor sie die Ausführung abgeschlossen hat, wurde SQLCancel oder SQLCancelHandle für die Anweisungshandle aufgerufen. Anschließend wurde die Funktion erneut für " StatementHandle" aufgerufen.

Die Funktion wurde aufgerufen, und bevor sie die Ausführung abgeschlossen hat, wurde SQLCancel oder SQLCancelHandle für das StatementHandle von einem anderen Thread in einer Multithreadanwendung aufgerufen.
HY009 Ungültige Verwendung des Nullzeigers Das Attribut SQL_ATTR_METADATA_ID Statement wurde auf SQL_TRUE gesetzt, das CatalogName-Argument war ein Nullzeiger, und der SQL_CATALOG_NAME InfoType gibt an, dass Katalognamen unterstützt werden.

(DM) Das Attribut SQL_ATTR_METADATA_ID Statement wurde auf SQL_TRUE gesetzt, und das SchemaName- oder ProcName-Argument war ein Nullzeiger.
HY010 Funktionssequenzfehler (DM) Eine asynchron ausgeführte Funktion wurde für den Verbindungshandle aufgerufen, der dem StatementHandle zugeordnet ist. Diese asynchrone Funktion lief noch, als diese Funktion aufgerufen wurde.

(DM) SQLExecute, SQLExecDirect oder SQLMoreResults wurde für " StatementHandle " aufgerufen und SQL_PARAM_DATA_AVAILABLE zurückgegeben. Diese Funktion wurde aufgerufen, bevor Daten für alle gestreamten Parameter abgerufen wurden.

(DM) Eine asynchron ausgeführte Funktion (nicht diese) wurde für das StatementHandle aufgerufen und wurde noch ausgeführt, als diese Funktion aufgerufen wurde.

(DM) SQLExecute, SQLExecDirect, SQLBulkOperations oder SQLSetPos wurde für " StatementHandle " aufgerufen und SQL_NEED_DATA zurückgegeben. Diese Funktion wurde aufgerufen, bevor Daten für alle Daten bei ausführungsparametern oder -spalten gesendet wurden.
HY013 Speicherverwaltungsfehler Der Funktionsaufruf konnte nicht verarbeitet werden, da auf die zugrunde liegenden Speicherobjekte nicht zugegriffen werden konnte, möglicherweise aufgrund geringer Arbeitsspeicherbedingungen.
HY090 Ungültige Zeichenfolgen- oder Pufferlänge (DM) Der Wert eines der Namenslängenargumente war kleiner als 0, aber nicht gleich SQL_NTS.

Der Wert eines der Namenlängenargumente hat den maximal zulässigen Längenwert für den entsprechenden Namen überschritten.
HY117 Die Verbindung wird aufgrund des unbekannten Transaktionsstatus angehalten. Es sind nur Trenn- und schreibgeschützte Funktionen zulässig. (DM) Weitere Informationen zum angehaltenen Zustand finden Sie unter SQLEndTran Function.
HYC00 Optionales Feature wurde nicht implementiert Ein Prozedurkatalog wurde spezifiziert, und der Treiber oder die Datenquelle unterstützt keine Kataloge.

Ein Prozedurschema wurde festgelegt, und der Treiber oder die Datenquelle unterstützt keine Schemata.

Für das Prozedurschema oder den Prozedurnamen wurde ein String-Suchmuster angegeben, und die Datenquelle unterstützt keine Suchmuster für eines oder mehrere dieser Argumente.

Die Kombination der aktuellen Einstellungen der SQL_ATTR_CONCURRENCY- und SQL_ATTR_CURSOR_TYPE-Anweisungsattribute wurde vom Treiber oder der Datenquelle nicht unterstützt.

Das attribut der SQL_ATTR_USE_BOOKMARKS-Anweisung wurde auf SQL_UB_VARIABLE festgelegt, und das Attribut der SQL_ATTR_CURSOR_TYPE-Anweisung wurde auf einen Cursortyp festgelegt, für den der Treiber keine Lesezeichen unterstützt.
HYT00 Timeout überschritten Der Abfragetimeoutzeitraum ist abgelaufen, bevor die Datenquelle das angeforderte Resultset zurückgegeben hat. Der Timeoutzeitraum wird über SQLSetStmtAttr SQL_ATTR_QUERY_TIMEOUT festgelegt.
HYT01 Verbindungstimeout abgelaufen Der Zeitraum für das Verbindungstimeout ist abgelaufen, bevor die Datenquelle auf die Anforderung geantwortet hat. Der Verbindungstimeoutzeitraum wird über SQLSetConnectAttr SQL_ATTR_CONNECTION_TIMEOUT festgelegt.
IM001 Dieser Treiber unterstützt diese Funktion nicht. (DM) Der mit dem StatementHandle verknüpfte Treiber unterstützt diese Funktion nicht.
IM017 Die Abrufung ist im asynchronen Benachrichtigungsmodus deaktiviert. Immer wenn das Benachrichtigungsmodell verwendet wird, ist die Abrufung deaktiviert.
IM018 SQLCompleteAsync wurde nicht aufgerufen, um den vorherigen asynchronen Vorgang für dieses Handle abzuschließen. Wenn der vorherige Funktionsaufruf für das Handle SQL_STILL_EXECUTING zurückgibt und der Benachrichtigungsmodus aktiviert ist, muss SQLCompleteAsync für das Handle aufgerufen werden, um die Nachbearbeitung durchzuführen und den Vorgang abzuschließen.

Kommentare

SQLProcedures listet alle Prozeduren im angeforderten Bereich auf. Ein Benutzer kann die Berechtigung haben, eine dieser Verfahren auszuführen, oder auch nicht. Um die Barrierefreiheit zu überprüfen, kann eine Anwendung SQLGetInfo aufrufen und den SQL_ACCESSIBLE_PROCEDURES Informationswert überprüfen. Andernfalls muss die Anwendung in der Lage sein, mit einer Situation umzugehen, in der der Benutzer ein Verfahren auswählt, das er nicht ausführen kann. Informationen darüber, wie diese Informationen verwendet werden könnten, finden Sie unter Verfahren.

Note

Weitere Informationen zur allgemeinen Verwendung, zu Argumenten und zurückgegebenen Daten von ODBC-Katalogfunktionen finden Sie unter Katalogfunktionen.

SQLProcedures liefert die Ergebnisse als Standardergebnismenge zurück, geordnet nach PROCEDURE_CAT, PROCEDURE_SCHEMA und PROCEDURE_NAME.

Note

SQLProcedures geben möglicherweise nicht alle Verfahren zurück. Anwendungen können jede gültige Prozedur verwenden, unabhängig davon, ob sie von SQLProcedures zurückgegeben wird oder nicht.

Die folgenden Kolumnen wurden für ODBC 3*.x* umbenannt. Die Änderungen des Spaltennamens beeinflussen die Abwärtskompatibilität nicht, da Anwendungen nach Spaltennummer binden.

ODBC 2.0-Spalte ODBC 3*.x*-Spalte
PROCEDURE_QUALIFIER PROCEDURE_CAT
PROCEDURE _OWNER PROCEDURE _SCHEM

Um die tatsächlichen Längen der Spalten PROCEDURE_CAT, PROCEDURE_SCHEM und PROCEDURE_NAME zu bestimmen, kann eine Anwendung SQLGetInfo mit den Optionen SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN und SQL_MAX_PROCEDURE_NAME_LEN aufrufen.

In der folgenden Tabelle sind die Spalten im Resultset aufgeführt. Zusätzliche Spalten über Spalte 8 (PROCEDURE_TYPE) hinaus können vom Treiber definiert werden. Eine Anwendung sollte auf treiberspezifische Spalten zuzugreifen, indem sie vom Ende der Ergebnismenge herunterzählt, anstatt eine explizite Ordinalposition anzugeben. Weitere Informationen finden Sie unter "Von Katalogfunktionen zurückgegebene Daten".

Spaltenname Spaltennummer Datentyp Kommentare
PROCEDURE_CAT (ODBC 2.0) 1 Varchar Verfahrenskatalog-Kennung; NULL, falls es nicht auf die Datenquelle anwendbar ist. Wenn ein Treiber Kataloge für einige Prozeduren unterstützt, aber nicht für andere, etwa wenn der Treiber Daten aus verschiedenen DBMS abruft, gibt er für jene Prozeduren, die keine Kataloge besitzen, eine leere Zeichenkette ("") zurück.
PROCEDURE_SCHEM (ODBC 2.0) 2 Varchar Prozedurschema-Kennung; NULL, falls es nicht auf die Datenquelle anwendbar ist. Wenn ein Treiber Schemata für einige Prozeduren unterstützt, aber nicht für andere, etwa wenn der Treiber Daten aus verschiedenen DBMSs abruft, gibt er für jene Prozeduren, die keine Schemata besitzen, eine leere Zeichenkette ("") zurück.
PROCEDURE_NAME (ODBC 2.0) 3 Varchar nicht NULL Prozedur-Kennung.
NUM_INPUT_PARAMS (ODBC 2.0) 4 N/A Reserviert für zukünftige Verwendung. Anwendungen sollten sich nicht auf die in diesen Ergebnisspalten zurückgegebenen Daten verlassen.
NUM_OUTPUT_PARAMS (ODBC 2.0) 5 N/A Reserviert für zukünftige Verwendung. Anwendungen sollten sich nicht auf die in diesen Ergebnisspalten zurückgegebenen Daten verlassen.
NUM_RESULT_SETS (ODBC 2.0) 6 N/A Reserviert für zukünftige Verwendung. Anwendungen sollten sich nicht auf die in diesen Ergebnisspalten zurückgegebenen Daten verlassen.
BEMERKUNGEN (ODBC 2.0) 7 Varchar Eine Beschreibung des Verfahrens.
PROCEDURE_TYPE (ODBC 2.0) 8 Smallint Definiert den Verfahrenstyp:

SQL_PT_UNKNOWN: Es kann nicht festgestellt werden, ob das Verfahren einen Wert zurückgibt.

SQL_PT_PROCEDURE: Das zurückgegebene Objekt ist ein Verfahren; das heißt, sie hat keinen Rückspruchswert.

SQL_PT_FUNCTION: Das zurückgegebene Objekt ist eine Funktion; das heißt, sie hat einen Rückspruchswert.

Die Argumente SchemaName und ProcName akzeptieren Suchmuster. Weitere Informationen zu gültigen Suchmustern finden Sie unter Pattern Value Arguments.

Codebeispiel

Siehe Verfahrensanrufe.

Informationen zum Siehe
Binden eines Puffers an eine Spalte in einem Resultset SQLBindCol-Funktion
Abbrechen der Verarbeitung von Anweisungen SQLCancel-Funktion
Abruf einer einzelnen Zeile oder einem Datenblock in einer ausschließlich vorwärtsgerichteten Richtung SQLFetch-Funktion
Abrufen eines Datenblocks oder Scrollen durch ein Resultset SQLFetchScroll-Funktion
Rückgabe von Informationen über einen Treiber oder eine Datenquelle SQLGetInfo-Funktion
Rückgabe der Parameter- und Ergebnisset-Spalten eines Verfahrens SQLProcedureColumns-Funktion
Syntax zum Aufrufen gespeicherter Prozeduren Ausführung von Anweisungen

Siehe auch

ODBC-API-Referenz
ODBC-Headerdateien

  • Last updated on