Funzione SQLProcedureColumns

Conformità
Versione introdotta: Conformità agli standard ODBC 1.0: ODBC

Riepilogo
SQLProcedureColumns restituisce l'elenco di parametri di input e output, nonché le colonne che costituiscono il set di risultati per le procedure specificate. Il driver restituisce le informazioni come set di risultati nell'istruzione specificata.

Sintassi

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

Argomenti

StatementHandle
[Input] Handle di istruzione.

CatalogName
[Input] Nome catalogo procedure. Se un driver supporta cataloghi 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 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.

ColumnName
[Input] Modello di ricerca di stringhe per i nomi di colonna.

Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, ColumnName viene considerato come identificatore e il relativo case non è significativo. Se è SQL_FALSE, ColumnName è un argomento del valore del criterio; viene trattato letteralmente e il relativo case è significativo.

NameLength4
[Input] Lunghezza in caratteri di *ColumnName.

Resi

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR o SQL_INVALID_HANDLE.

Diagnostica

Quando SQLProcedureColumns 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 SQLProcedureColumns e 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.

Commenti

Questa funzione viene in genere utilizzata prima dell'esecuzione dell'istruzione per recuperare informazioni sui parametri della routine e sulle colonne che costituiscono il set di risultati o i set restituiti dalla routine, se presenti. Per altre informazioni, vedere Routine.

Gli argomenti SchemaName, ProcName e ColumnName accettano criteri di ricerca. Per altre informazioni sui modelli di ricerca validi, vedere Argomenti dei valori del criterio.

SQLProcedureColumns restituisce i risultati come set di risultati standard, ordinati in base a PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME e COLUMN_TYPE. I nomi delle colonne vengono restituiti per ogni routine nell'ordine seguente: il nome del valore restituito, i nomi di ogni parametro nella chiamata di routine (in ordine di chiamata) e quindi i nomi di ogni colonna nel set di risultati restituito dalla routine (in ordine di colonna).

Le applicazioni devono associare colonne specifiche del driver rispetto alla fine del set di risultati. Per altre informazioni, vedere Dati restituiti dalle funzioni del catalogo.

Per determinare le lunghezze effettive delle colonne PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME e COLUMN_NAME, un'applicazione può chiamare SQLGetInfo con le opzioni di SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_PROCEDURE_NAME_LEN e SQL_MAX_COLUMN_NAME_LEN.

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.

Le colonne seguenti sono state aggiunte al set di risultati restituito da SQLProcedureColumns per ODBC 3.x:

• COLUMN_DEF

• DATETIME_CODE

• CHAR_OCTET_LENGTH

• ORDINAL_POSITION

• IS_NULLABLE

Nella tabella seguente sono elencate le colonne nel set di risultati. Le colonne aggiuntive successive alla colonna 19 (IS_NULLABLE) 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.

Esempio di codice

Vedere Chiamate di procedura.

Funzioni correlate

Vedi anche

Riferimento API ODBC
File di intestazione ODBC