Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Conformità
Versione introdotta: Conformità agli standard ODBC 1.0: ODBC
Sommario
SQLProcedures restituisce l'elenco dei nomi delle procedure memorizzati in una specifica fonte di dati.
Procedura è un termine generico usato per descrivere un oggetto eseguibile, o un'entità nominata che può essere invocata utilizzando parametri di input e output. Per maggiori informazioni sulle procedure, consulta le Procedure.
Syntax
SQLRETURN SQLProcedures(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3);
Arguments
StatementHandle
[Input] Handle di istruzione.
CatalogName
[Input] Catalogo delle procedure. Se un driver supporta cataloghi per alcune tabelle ma non per altre, ad esempio quando il driver recupera dati da diversi DBMS, una stringa vuota ("") indica quelle tabelle che non hanno cataloghi.
CatalogName non può contenere un pattern di ricerca a stringhe.
Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, CatalogName viene trattato come un identificatore e il suo caso non è significativo. Se è SQL_FALSE, CatalogName è un argomento ordinario; Viene trattato letteralmente, e il suo caso è significativo. Per altre informazioni, vedere Argomenti nelle Funzioni catalogo.
NameLength1
[Input] Lunghezza nei caratteri di *NomeCatalogo.
SchemaName
[Input] Pattern di ricerca stringa per i nomi degli schemi delle procedure. Se un driver supporta gli schemi per alcune procedure ma non per altre, ad esempio quando il driver recupera dati da diversi DBMS, una stringa vuota ("") indica quelle procedure che non hanno schema.
Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, SchemaName viene trattato come un identificatore e il suo caso non è significativo. Se è SQL_FALSE, Nome dello schema è un argomento di valore di pattern; Viene trattato letteralmente, e il suo caso è significativo.
NameLength2
[Input] Lunghezza nei caratteri di *NomeSchema.
ProcName
[Input] Pattern di ricerca stringa per i nomi delle procedure.
Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, ProcName viene trattato come un identificatore e il suo caso non è significativo. Se è SQL_FALSE, ProcName è un argomento di valore di pattern; Viene trattato letteralmente, e il suo caso è significativo.
NameLength3
[Input] Lunghezza nei caratteri di *ProcName.
Returns
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR o SQL_INVALID_HANDLE.
Diagnostics
Quando SQLProcedures restituisce SQL_ERROR o SQL_SUCCESS_WITH_INFO, un valore SQLSTATE associato può essere ottenuto chiamando SQLGetDiagRec con un HandleType di SQL_HANDLE_STMT e un Handle di StatementHandle. La tabella seguente elenca i valori SQLSTATE comunemente restituiti da SQLProcedures e spiega ciascuno nel contesto di questa funzione; la notazione "(DM)" precede le descrizioni degli stati SQL restituite dal Driver Manager. Il codice restituito associato a ogni valore SQLSTATE è SQL_ERROR, a meno che non sia specificato diversamente.
| SQLSTATE | Error | Description |
|---|---|---|
| 01000 | Avviso generale | Messaggio informativo specifico del driver. (La funzione restituisce SQL_SUCCESS_WITH_INFO. |
| 08S01 | Errore del collegamento di comunicazione | Collegamento di comunicazione tra il driver e l'origine dati a cui è stato connesso il driver non è riuscito prima del completamento dell'elaborazione della funzione. |
| 24000 | Stato del cursore non valido | Un cursore era aperto sull'InstructionHandle, e erano stati chiamati SQLFetch o SQLFetchScroll . Questo errore viene restituito da Gestione driver se SQLFetch o SQLFetchScroll non ha restituito SQL_NO_DATA e viene restituito dal driver se SQLFetch o SQLFetchScroll ha restituito SQL_NO_DATA. Un cursore era aperto sull'InstructionHandle, ma SQLFetch o SQLFetchScroll non erano stati chiamati. |
| 40001 | Errore di serializzazione | È stato eseguito il rollback della transazione a causa di un deadlock della risorsa con un'altra transazione. |
| 40003 | Completamento istruzione sconosciuto | La connessione associata non è riuscita durante l'esecuzione di questa funzione e non è possibile determinare lo stato della transazione. |
| HY000 | Errore generale | Si è verificato un errore per il quale non è stato specificato SQLSTATE e per il quale non è stato definito alcun SQLSTATE specifico dell'implementazione. Il messaggio di errore restituito da SQLGetDiagRec nel buffer *MessageText descrive l'errore e la relativa causa. |
| HY001 | Errore di allocazione della memoria | Il driver non è riuscito ad allocare memoria necessaria per supportare l'esecuzione o il completamento della funzione. |
| HY008 | Operazione annullata | L'elaborazione asincrona è stata abilitata per StatementHandle. La funzione è stata chiamata e prima di completare l'esecuzione, SQLCancel o SQLCancelHandle è stata chiamata in StatementHandle. La funzione è stata quindi chiamata di nuovo in StatementHandle. La funzione è stata chiamata e prima del completamento dell'esecuzione, SQLCancel o SQLCancelHandle è stato chiamato su StatementHandle da un thread diverso in un'applicazione multithread. |
| HY009 | Uso non valido del puntatore Null | L'attributo SQL_ATTR_METADATA_ID istruzione era impostato su SQL_TRUE, l'argomento CatalogName era un puntatore nullo e l'InfoType SQL_CATALOG_NAME restituisce che i nomi dei cataloghi sono supportati. (DM) L'attributo dell'istruzione SQL_ATTR_METADATA_ID era impostato su SQL_TRUE, e l'argomento SchemaName o ProcName era un puntatore nullo. |
| HY010 | Errore della sequenza di funzioni | (DM) È stata chiamata una funzione in esecuzione asincrona per l'handle di connessione associato a StatementHandle. Questa funzione asincrona era ancora in esecuzione quando fu chiamata. (DM) SQLExecute, SQLExecDirect o SQLMoreResults è stato chiamato per StatementHandle e restituito SQL_PARAM_DATA_AVAILABLE. Questa funzione è stata chiamata prima del recupero dei dati per tutti i parametri trasmessi. (DM) Una funzione in esecuzione asincrona (non questa) è stata chiamata per StatementHandle ed è ancora in esecuzione quando questa funzione è stata chiamata. (DM) SQLExecute, SQLExecDirect, SQLBulkOperations o SQLSetPos è stato chiamato per StatementHandle e restituito SQL_NEED_DATA. Questa funzione è stata chiamata prima dell'invio dei dati per tutti i parametri o le colonne data-at-execution. |
| HY013 | Errore di gestione della memoria | Impossibile elaborare la chiamata di funzione perché non è stato possibile accedere agli oggetti di memoria sottostanti, probabilmente a causa di condizioni di memoria insufficiente. |
| HY090 | Lunghezza della stringa o del buffer non valida | (DM) Il valore di uno degli argomenti della lunghezza del nome era inferiore a 0 ma non uguale a SQL_NTS. Il valore di uno degli argomenti lunghezza nome ha superato il valore di lunghezza massima per il nome corrispondente. |
| HY117 | La connessione viene sospesa a causa dello stato sconosciuto della transazione. Sono consentite solo funzioni disconnesse e di sola lettura. | (DM) Per altre informazioni sullo stato sospeso, vedere Funzione SQLEndTran. |
| HYC00 | Funzionalità facoltativa non implementata | È stato specificato un catalogo di procedure, e il driver o la sorgente dati non supportano i cataloghi. È stato specificato uno schema procedura, e il driver o la sorgente dati non supportano gli schemi. È stato specificato un pattern di ricerca a stringhe per lo schema o il nome della procedura, e la sorgente dati non supporta schemi di ricerca per uno o più di questi argomenti. La combinazione delle impostazioni correnti degli attributi delle istruzioni SQL_ATTR_CONCURRENCY e SQL_ATTR_CURSOR_TYPE non è supportata dal driver o dall'origine dati. L'attributo di istruzione SQL_ATTR_USE_BOOKMARKS è stato impostato su SQL_UB_VARIABLE e l'attributo dell'istruzione SQL_ATTR_CURSOR_TYPE è stato impostato su un tipo di cursore per cui il driver non supporta i segnalibri. |
| HYT00 | Timeout scaduto | Periodo di timeout della query scaduto prima che l'origine dati restituisca il set di risultati richiesto. Il periodo di timeout viene impostato tramite SQLSetStmtAttr, SQL_ATTR_QUERY_TIMEOUT. |
| HYT01 | Il timeout della connessione è scaduto | Periodo di timeout della connessione scaduto prima che l'origine dati rispondesse alla richiesta. Il periodo di timeout della connessione viene impostato tramite SQLSetConnectAttr, SQL_ATTR_CONNECTION_TIMEOUT. |
| IM001 | Il driver non supporta questa funzione | (DM) Il driver associato al StatementHandle non supporta questa funzione. |
| IM017 | Il polling è disabilitato in modalità di notifica asincrona | Ogni volta che viene usato il modello di notifica, il polling è disabilitato. |
| IM018 | SQLCompleteAsync non è stato chiamato per completare l'operazione asincrona precedente su questo handle. | Se la chiamata di funzione precedente sull'handle restituisce SQL_STILL_EXECUTING e se la modalità di notifica è abilitata, è necessario chiamare SQLCompleteAsync sull'handle per eseguire la post-elaborazione e completare l'operazione. |
Comments
SQLProcedures elenca tutte le procedure nell'intervallo richiesto. Un utente può avere o meno il permesso di eseguire una qualsiasi di queste procedure. Per verificarne l'accessibilità, un'applicazione può chiamare SQLGetInfo e verificare il valore delle informazioni SQL_ACCESSIBLE_PROCEDURES. Altrimenti, l'applicazione deve essere in grado di gestire una situazione in cui l'utente seleziona una procedura che non può eseguire. Per informazioni su come queste informazioni potrebbero essere utilizzate, vedi Procedure.
Nota
Per altre informazioni sull'utilizzo generale, gli argomenti e i dati restituiti delle funzioni del catalogo ODBC, vedere Funzioni del catalogo.
SQLProcedures restituisce i risultati come un insieme standard, ordinato da PROCEDURE_CAT, PROCEDURE_SCHEMA e PROCEDURE_NAME.
Nota
SQLProcedures potrebbe non restituire tutte le procedure. Le applicazioni possono utilizzare qualsiasi procedura valida, indipendentemente dal fatto che venga restituita tramite SQLProcedures.
Le colonne seguenti sono state rinominate in ODBC 3*.x*. I cambiamenti nel nome delle colonne non influiscono sulla retrocompatibilità perché le applicazioni si assegnano per numero di colonna.
| Colonna ODBC 2.0 | Colonna ODBC 3*.x* |
|---|---|
| PROCEDURE_QUALIFIER | CATEGORIA_PROCEDURA |
| PROCEDURE _OWNER | PROCEDURE _SCHEM |
Per determinare la lunghezza effettiva delle colonne PROCEDURE_CAT, PROCEDURE_SCHEM e PROCEDURE_NAME, un'applicazione può chiamare SQLGetInfo con le opzioni SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN e SQL_MAX_PROCEDURE_NAME_LEN.
Nella tabella seguente sono elencate le colonne nel set di risultati. Colonne aggiuntive oltre la colonna 8 (PROCEDURE_TYPE) possono essere definite dal driver. Un'applicazione dovrebbe accedere alle colonne specifiche del driver contando alla rovescia dalla fine del set di risultati invece di specificare una posizione ordinale esplicita. Per altre informazioni, vedere Dati restituiti dalle funzioni del catalogo.
| Nome della colonna | Numero di colonna | Tipo di dati | Comments |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | Identificatore del catalogo delle procedure; NULL se non applicabile alla fonte dati. Se un driver supporta cataloghi per alcune procedure ma non per altre, ad esempio quando il driver recupera dati da diversi DBMS, restituisce una stringa vuota ("") per quelle procedure che non hanno cataloghi. |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | Identificatore dello schema delle procedure; NULL se non applicabile alla fonte dati. Se un driver supporta schemi per alcune procedure ma non per altre, ad esempio quando recupera dati da diversi DBMS, restituisce una stringa vuota ("") per quelle procedure che non hanno schema. |
| PROCEDURE_NAME (ODBC 2.0) | 3 | Varchar non NULL | Identificatore di procedura. |
| NUM_INPUT_PARAMS (ODBC 2.0) | 4 | N/A | Riservato a un uso futuro. Le applicazioni non dovrebbero basarsi sui dati restituiti in queste colonne dei risultati. |
| NUM_OUTPUT_PARAMS (ODBC 2.0) | 5 | N/A | Riservato a un uso futuro. Le applicazioni non dovrebbero basarsi sui dati restituiti in queste colonne dei risultati. |
| NUM_RESULT_SETS (ODBC 2.0) | 6 | N/A | Riservato a un uso futuro. Le applicazioni non dovrebbero basarsi sui dati restituiti in queste colonne dei risultati. |
| OSSERVAZIONI (ODBC 2.0) | 7 | Varchar | Una descrizione della procedura. |
| PROCEDURE_TYPE (ODBC 2.0) | 8 | Smallint | Definisce il tipo di procedura: SQL_PT_UNKNOWN: Non si può determinare se la procedura restituisca un valore. SQL_PT_PROCEDURE: L'oggetto restituito è una procedura; cioè, non ha un valore di ritorno. SQL_PT_FUNCTION: L'oggetto restituito è una funzione; cioè, ha un valore di ritorno. |
Gli argomenti SchemaName e ProcName accettano pattern di ricerca. Per maggiori informazioni sui modelli di ricerca validi, vedi Pattern Value Arguments.
Esempio di codice
Funzioni correlate
| Per informazioni su | Vedi |
|---|---|
| Associazione di un buffer a una colonna in un set di risultati | Funzione SQLBindCol |
| Annullamento dell'elaborazione delle istruzioni | Funzione SQLCancel |
| Recupero di una singola riga o di un blocco di dati in direzione solo in avanti | Funzione SQLFetch |
| Recupero di un blocco di dati o scorrimento di un set di risultati | Funzione SQLFetchScroll |
| Restituire informazioni su un driver o una fonte di dati | Funzione SQLGetInfo |
| Restituire i parametri e le colonne dell'insieme dei risultati di una procedura | Funzione SQLProcedureColumns |
| Sintassi per l'invocazione di stored procedure | Esecuzione di istruzioni |