Funzione JetRetrieveColumns

Si applica a: Windows | server Windows

Funzione JetRetrieveColumns

La funzione JetRetrieveColumns recupera più valori di colonna dal record corrente in una singola operazione. Una matrice di strutture JET_RETRIEVECOLUMN viene usata per descrivere il set di valori di colonna da recuperare e per descrivere i buffer di output per ogni valore di colonna da recuperare.

    JET_ERR JET_API JetRetrieveColumns(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in_out_opt  JET_RETRIEVECOLUMN* pretrievecolumn,
      __in          unsigned long cretrievecolumn
    );

Parametri

sesid

Sessione da utilizzare per questa chiamata.

tableid

Cursore da utilizzare per questa chiamata.

pretrievecolumn

Puntatore a una matrice di una o più strutture JET_RETRIEVECOLUMN . Ogni struttura include descrizioni del valore della colonna da recuperare e della posizione in cui archiviare i dati restituiti.

cretrievecolumn

Numero di strutture JET_RETRIEVECOLUMN nella matrice specificata da pretrievecolumn.

Valore restituito

Questa funzione restituisce il tipo di dati JET_ERR con uno dei codici restituiti seguenti. Per altre informazioni sui possibili errori ESE, vedere Extensible Archiviazione Engine Errors and Error Handling Parameters.For more information about the possible ESE errors errors, see Extensible Archiviazione Engine Errors and Error Handling Parameters.

In caso di esito positivo, le dimensioni dei dati e delle colonne vengono restituite nei buffer forniti descritti nella matrice di strutture JET_RETRIEVECOLUMN . Se un itagSequence è stato impostato su 0 (zero) per indicare che il numero di istanze di un campo multivalore è stato desiderato anziché dati di colonna, il numero di istanze di una colonna multivalore viene restituito nel campo itagSequence stesso. Ogni struttura JET_RETRIEVECOLUMN contiene un campo di errore che contiene avvisi per la colonna recuperata. Se la colonna è stata impostata su NULL, il codice di errore verrà impostato su JET_wrnColumnNull.

In caso di errore, la posizione del cursore rimane invariata e non vengono copiati dati nel buffer specificato.

Commenti

JetRetrieveColumns supporta una funzionalità non supportata da JetRetrieveColumn . Si tratta della possibilità di recuperare il numero di istanze di una colonna multivalore. Lo scopo di questa funzionalità è consentire a un'applicazione di recuperare tutti i valori di una colonna. Questa operazione può essere eseguita determinando innanzitutto il numero di valori di una colonna. Successivamente, è possibile determinare le lunghezze chiamando JetRetrieveColumns con una struttura JET_RETRIEVECOLUMN allocata per ogni valore per determinare la lunghezza dei dati della colonna. A tale scopo, è possibile passare puntatori NULLpvData con cbMax pari a 0 (zero) e recuperare la lunghezza della colonna in cbActual. La terza e l'ultima chiamata possono essere effettuate con la memoria allocata per i dati del valore della colonna.

Se una colonna recuperata viene troncata a causa di un buffer di lunghezza insufficiente, l'API restituirà JET_wrnBufferTruncated. Tuttavia, altri errori, JET_wrnColumnNull vengono restituiti solo nel campo di errore in JET_RETRIEVECOLUMN. Il motivo è che le applicazioni spesso vogliono assicurarsi che tutti i dati siano stati recuperati e che venga restituito questo errore da JetRetrieveColumns facilita questa comprensione.

Requisiti

Vedere anche

JET_ERR
JET_SESID
JET_TABLEID
JET_RETRIEVECOLUMN
JetEnumerateColumns
JetRetrieveColumn
JetSetColumns