Funzione SQLSetDescRec

Conformità
Versione introdotta: Conformità agli standard ODBC 3.0: ISO 92

Riepilogo
La funzione SQLSetDescRec imposta più campi descrittori che influiscono sul tipo di dati e sul buffer associati a una colonna o ai dati dei parametri.

Sintassi

  
SQLRETURN SQLSetDescRec(  
      SQLHDESC      DescriptorHandle,  
      SQLSMALLINT   RecNumber,  
      SQLSMALLINT   Type,  
      SQLSMALLINT   SubType,  
      SQLLEN        Length,  
      SQLSMALLINT   Precision,  
      SQLSMALLINT   Scale,  
      SQLPOINTER    DataPtr,  
      SQLLEN *      StringLengthPtr,  
      SQLLEN *      IndicatorPtr);  

Argomenti

DescriptorHandle
[Input] Handle del descrittore. Questo non deve essere un handle IRD.

RecNumber
[Input] Indica il record descrittore che contiene i campi da impostare. I record del descrittore sono numerati da 0, con il numero di record 0 come record del segnalibro. Questo argomento deve essere uguale o maggiore di 0. Se RecNumber è maggiore del valore di SQL_DESC_COUNT, SQL_DESC_COUNTis modificato nel valore di RecNumber.

Tipo
[Input] Valore a cui impostare il campo SQL_DESC_TYPE per il record descrittore.

Sottotipo
[Input] Per i record il cui tipo è SQL_DATETIME o SQL_INTERVAL, si tratta del valore a cui impostare il campo SQL_DESC_DATETIME_INTERVAL_CODE.

Lunghezza
[Input] Valore a cui impostare il campo SQL_DESC_OCTET_LENGTH per il record descrittore.

Precisione
[Input] Valore a cui impostare il campo SQL_DESC_PRECISION per il record descrittore.

Ridimensiona
[Input] Valore a cui impostare il campo SQL_DESC_SCALE per il record descrittore.

DataPtr
[Input o output posticipato] Valore a cui impostare il campo SQL_DESC_DATA_PTR per il record descrittore. DataPtr può essere impostato su un puntatore Null.

L'argomento DataPtr può essere impostato su un puntatore Null per impostare il campo SQL_DESC_DATA_PTR su un puntatore Null. Se l'handle nell'argomento DescriptorHandle è associato a un ARD, verrà annullata l'associazione della colonna.

StringLengthPtr
[Input o output posticipato] Valore a cui impostare il campo SQL_DESC_OCTET_LENGTH_PTR per il record del descrittore. StringLengthPtr può essere impostato su un puntatore Null per impostare il campo SQL_DESC_OCTET_LENGTH_PTR su un puntatore Null.

IndicatorPtr
[Input o output posticipato] Valore a cui impostare il campo SQL_DESC_INDICATOR_PTR per il record descrittore. IndicatorPtr può essere impostato su un puntatore Null per impostare il campo SQL_DESC_INDICATOR_PTR su un puntatore Null.

Resi

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR o SQL_INVALID_HANDLE.

Diagnostica

Quando SQLSetDescRec restituisce SQL_ERROR o SQL_SUCCESS_WITH_INFO, è possibile ottenere un valore SQLSTATE associato chiamando SQLGetDiagRec con handleTypedi SQL_HANDLE_DESC e handle di descrittoreHandle. La tabella seguente elenca i valori SQLSTATE comunemente restituiti da SQLSetDescRec e spiega ognuno di essi 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

Un'applicazione può chiamare SQLSetDescRec per impostare i campi seguenti per una singola colonna o parametro:

• SQL_DESC_TYPE

• SQL_DESC_DATETIME_INTERVAL_CODE (per i record il cui tipo è SQL_DATETIME o SQL_INTERVAL)

• SQL_DESC_OCTET_LENGTH

• SQL_DESC_PRECISION

• SQL_DESC_SCALE

• SQL_DESC_DATA_PTR

• SQL_DESC_OCTET_LENGTH_PTR

• SQL_DESC_INDICATOR_PTR

Quando si associa una colonna o un parametro, SQLSetDescRec consente di modificare più campi che influiscono sull'associazione senza chiamare SQLBindCol o SQLBindParameter o effettuare più chiamate a SQLSetDescField. SQLSetDescRec può impostare campi in un descrittore non attualmente associato a un'istruzione . Si noti che SQLBindParameter imposta più campi rispetto a SQLSetDescRec, può impostare campi sia in un APD che in un IPD in una chiamata e non richiede un handle descrittore.

Controlli di coerenza

Un controllo di coerenza viene eseguito automaticamente dal driver ogni volta che un'applicazione imposta il campo SQL_DESC_DATA_PTR di un APD, ARD o IPD. Se uno dei campi non è coerente con altri campi, SQLSetDescRec restituirà SQLSTATE HY021 (informazioni del descrittore incoerente).

Ogni volta che un'applicazione imposta il campo SQL_DESC_DATA_PTR di un oggetto APD, ARD o IPD, il driver verifica che il valore del campo SQL_DESC_TYPE e i valori applicabili a tale campo SQL_DESC_TYPE siano validi e coerenti. Questo controllo viene sempre eseguito quando viene chiamato SQLBindParameter o SQLBindCol o quando SQLSetDescRec viene chiamato per un APD, ARD o IPD. Questa verifica coerenza include i controlli seguenti sui campi del descrittore:

• Il campo SQL_DESC_TYPE deve essere uno dei tipi ODBC C o SQL validi o un tipo SQL specifico del driver. Il campo SQL_DESC_CONCISE_TYPE deve essere uno dei tipi ODBC C o SQL validi oppure un tipo C o SQL specifico del driver, inclusi i tipi datetime e interval concisi.

• Se il campo del record SQL_DESC_TYPE è SQL_DATETIME o SQL_INTERVAL, il campo SQL_DESC_DATETIME_INTERVAL_CODE deve essere uno dei codici datetime o interval validi. Vedere la descrizione del campo SQL_DESC_DATETIME_INTERVAL_CODE in SQLSetDescField.

• Se il campo SQL_DESC_TYPE indica un tipo numerico, i campi SQL_DESC_PRECISION e SQL_DESC_SCALE vengono verificati come validi.

• Se il campo SQL_DESC_CONCISE_TYPE è un tipo di dati time o timestamp, un tipo di intervallo con un componente secondi o uno dei tipi di dati intervallo con un componente time, il campo SQL_DESC_PRECISION viene verificato come una precisione di secondi valida.

• Se il SQL_DESC_CONCISE_TYPE è un tipo di dati interval, il campo SQL_DESC_DATETIME_INTERVAL_PRECISION viene verificato che sia un valore di precisione iniziale intervallo valido.

Il campo SQL_DESC_DATA_PTR di un IPD non è in genere impostato; Tuttavia, un'applicazione può eseguire questa operazione per forzare una verifica coerenza dei campi IPD. Non è possibile eseguire un controllo di coerenza su un IRD. Il valore su cui il campo SQL_DESC_DATA_PTR dell'IPD non è effettivamente archiviato e non può essere recuperato da una chiamata a SQLGetDescField o SQLGetDescRec. L'impostazione viene eseguita solo per forzare la verifica coerenza.

Funzioni correlate

Vedi anche

Riferimento API ODBC
File di intestazione ODBC