Funzione SQLProcedures
Conformità
Versione introdotta: Conformità agli standard ODBC 1.0: ODBC
Riepilogo
SQLProcedures restituisce l'elenco di nomi di routine archiviati in un'origine dati specifica. Procedure è un termine generico usato per descrivere un oggetto eseguibile o un'entità denominata che può essere richiamata usando parametri di input e output. Per altre informazioni sulle procedure, vedere Procedure.
Sintassi
SQLRETURN SQLProcedures(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3);
Argomenti
StatementHandle
[Input] Handle di istruzione.
CatalogName
[Input] Catalogo procedure. Se un driver supporta cataloghi per alcune tabelle ma non per altri, ad esempio quando il driver recupera i dati da diversi DBMS, una stringa vuota ("") indica le tabelle che non dispongono di cataloghi. CatalogName non può contenere un criterio di ricerca di stringhe.
Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, CatalogName viene considerato come identificatore e il relativo case non è significativo. Se è SQL_FALSE, CatalogName è un argomento ordinario; viene trattato letteralmente e il relativo caso è significativo. Per altre informazioni, vedere Argomenti in Funzioni del catalogo.
NameLength1
[Input] Lunghezza in caratteri di *CatalogName.
SchemaName
[Input] Modello di ricerca di stringhe per i nomi degli schemi delle procedure. Se un driver supporta schemi per alcune procedure ma non per altri, ad esempio quando il driver recupera i dati da diversi DBMS, una stringa vuota ("") indica le procedure che non dispongono di schemi.
Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, SchemaName viene considerato come identificatore e il relativo case non è significativo. Se è SQL_FALSE, SchemaName è un argomento del valore del modello, che viene trattato letteralmente e il relativo case è significativo.
NameLength2
[Input] Lunghezza in caratteri di *SchemaName.
ProcName
[Input] Modello di ricerca di stringhe per i nomi delle procedure.
Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, ProcName viene considerato come identificatore e il relativo case non è significativo. Se è SQL_FALSE, ProcName è un argomento del valore del criterio; viene trattato letteralmente e il relativo case è significativo.
NameLength3
[Input] Lunghezza in caratteri di *ProcName.
Resi
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR o SQL_INVALID_HANDLE.
Diagnostica
Quando SQLProcedures restituisce SQL_ERROR o SQL_SUCCESS_WITH_INFO, è possibile ottenere un valore SQLSTATE associato chiamando SQLGetDiagRec con handleTypedi SQL_HANDLE_STMT e handle di StatementHandle. La tabella seguente elenca i valori SQLSTATE comunemente restituiti da SQLProcedures e ne spiega ognuno nel contesto di questa funzione. La notazione "(DM)" precede le descrizioni di SQLSTATEs restituite da Gestione driver. Il codice restituito associato a ogni valore SQLSTATE è SQL_ERROR, a meno che non sia specificato diversamente.
| SQLSTATE | Errore | Descrizione |
|---|---|---|
| 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 | È stato aperto un cursore in StatementHandle e è stato chiamato 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 è stato aperto in StatementHandle, ma SQLFetch o SQLFetchScroll non è stato chiamato. |
| 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 dell'istruzione SQL_ATTR_METADATA_ID è stato impostato su SQL_TRUE, l'argomento CatalogName è un puntatore Null e l'SQL_CATALOG_NAME InfoType restituisce che i nomi di catalogo sono supportati. (DM) L'attributo dell'istruzione SQL_ATTR_METADATA_ID è stato impostato su SQL_TRUE e l'argomento SchemaName o ProcName è un puntatore Null. |
| 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 questa funzione è stata 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 di lunghezza del nome è minore di 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 procedure e il driver o l'origine dati non supporta i cataloghi. È stato specificato uno schema di routine e il driver o l'origine dati non supporta gli schemi. È stato specificato un criterio di ricerca di stringhe per lo schema di routine o il nome della routine e l'origine dati non supporta i criteri 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 a 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. |
Commenti
SQLProcedures elenca tutte le procedure nell'intervallo richiesto. Un utente può avere o meno l'autorizzazione per eseguire una di queste procedure. Per controllare l'accessibilità, un'applicazione può chiamare SQLGetInfo e controllare il valore delle informazioni SQL_ACCESSIBLE_PROCEDURES. In caso contrario, l'applicazione deve essere in grado di gestire una situazione in cui l'utente seleziona una routine che non può eseguire. Per informazioni sull'utilizzo di queste informazioni, vedere 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 set di risultati standard, ordinato per PROCEDURE_CAT, PROCEDURE_SCHEMA e PROCEDURE_NAME.
Nota
SQLProcedures potrebbe non restituire tutte le procedure. Le applicazioni possono usare qualsiasi procedura valida, indipendentemente dal fatto che venga restituita da SQLProcedures.
Le colonne seguenti sono state rinominate per ODBC 3*.x*. Le modifiche apportate al nome della colonna non influiscono sulla compatibilità con le versioni precedenti perché le applicazioni si associano per numero di colonna.
| Colonna ODBC 2.0 | Colonna ODBC 3*.x* |
|---|---|
| PROCEDURE_QUALIFIER | PROCEDURE_CAT |
| PROCEDURE _OWNER | PROCEDURE _SCHEM |
Per determinare le lunghezze effettive 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. Le colonne aggiuntive successive alla colonna 8 (PROCEDURE_TYPE) possono essere definite dal driver. Un'applicazione deve ottenere l'accesso alle colonne specifiche del driver con il conteggio dalla fine del set di risultati anziché specificare una posizione ordinale esplicita. Per altre informazioni, vedere Dati restituiti dalle funzioni del catalogo.
| Nome colonna | Column number | Tipo di dati | Commenti |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | Identificatore del catalogo procedure; NULL se non applicabile all'origine dati. Se un driver supporta cataloghi per alcune procedure, ma non per altri, ad esempio quando il driver recupera i dati da diversi DBMS, restituisce una stringa vuota ("") per le procedure che non dispongono di cataloghi. |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | Identificatore dello schema della procedura; NULL se non applicabile all'origine dati. Se un driver supporta schemi per alcune procedure ma non per altri, ad esempio quando il driver recupera i dati da diversi DBMS, restituisce una stringa vuota ("") per le routine che non dispongono di schemi. |
| PROCEDURE_NAME (ODBC 2.0) | 3 | Varchar non NULL | Identificatore di routine. |
| NUM_INPUT_PARAMS (ODBC 2.0) | 4 | N/D | Riservato a un uso futuro. Le applicazioni non devono basarsi sui dati restituiti in queste colonne di risultato. |
| NUM_OUTPUT_PARAMS (ODBC 2.0) | 5 | N/D | Riservato a un uso futuro. Le applicazioni non devono basarsi sui dati restituiti in queste colonne di risultato. |
| NUM_RESULT_SETS (ODBC 2.0) | 6 | N/D | Riservato a un uso futuro. Le applicazioni non devono basarsi sui dati restituiti in queste colonne di risultato. |
| OSSERVAZIONI (ODBC 2.0) | 7 | Varchar | Descrizione della procedura. |
| PROCEDURE_TYPE (ODBC 2.0) | 8 | Smallint | Definisce il tipo di routine: SQL_PT_UNKNOWN: non è possibile determinare se la routine restituisce un valore. SQL_PT_PROCEDURE: l'oggetto restituito è una routine; ovvero, non ha un valore restituito. SQL_PT_FUNCTION: l'oggetto restituito è una funzione; ovvero ha un valore restituito. |
Gli argomenti SchemaName e ProcName accettano modelli di ricerca. Per altre informazioni sui modelli di ricerca validi, vedere Argomenti dei valori del criterio.
Esempio di codice
Vedere Chiamate di procedura.
Funzioni correlate
| Per informazioni su | Vedere |
|---|---|
| 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 una direzione forward-only | Funzione SQLFetch |
| Recupero di un blocco di dati o scorrimento di un set di risultati | Funzione SQLFetchScroll |
| Restituzione di informazioni su un driver o un'origine dati | Funzione SQLGetInfo |
| Restituzione dei parametri e delle colonne del set di risultati di una routine | Funzione SQLProcedureColumns |
| Sintassi per richiamare stored procedure | Esecuzione di istruzioni |