Funzione SQLGetPrivateProfileString

Conformità
Versione introdotta: ODBC 2.0

Riepilogo
SQLGetPrivateProfileString ottiene un elenco di nomi di valori o dati corrispondenti a un valore delle informazioni di sistema.

Sintassi

  
int SQLGetPrivateProfileString(  
     LPCSTR   lpszSection,  
     LPCSTR   lpszEntry,  
     LPCSTR   lpszDefault,  
     LPCSTR   RetBuffer,  
     INT      cbRetBuffer,  
     LPCSTR   lpszFilename);  

Argomenti

lpszSection
[Input] Punta a una stringa con terminazione Null che specifica la sezione contenente il nome della chiave. Se questo argomento è NULL, la funzione copia tutti i nomi di sezione nel file nel buffer fornito.

lpszEntry
[Input] Punta alla stringa con terminazione Null contenente il nome della chiave la cui stringa associata deve essere recuperata. Se questo argomento è NULL, tutti i nomi di chiave nella sezione specificata dall'argomento lpszSection vengono copiati nel buffer specificato dall'argomento RetBuffer .

lpszDefault
[Input] Punta a una stringa con terminazione Null che specifica il valore predefinito per la chiave specificata se non è possibile trovare la chiave nel file di inizializzazione. Questo argomento non può essere NULL.

RetBuffer
[Output] Punta al buffer che riceve la stringa recuperata.

cbRetBuffer
[Input] Specifica le dimensioni, in caratteri, del buffer a cui punta l'argomento RetBuffer .

lpszFilename
[Input] Punta a una stringa con terminazione Null che denomina il file di inizializzazione. Se questo argomento non contiene un percorso completo del file, viene eseguita la ricerca nella directory predefinita.

Valori restituiti

SQLGetPrivateProfileString restituisce un valore intero che indica il numero di caratteri letti.

Diagnostica

Quando una chiamata a SQLGetPrivateProfileString ha esito negativo, è possibile ottenere un valore *pfErrorCode associato chiamando SQLInstallerError. Nella tabella seguente sono elencati i valori *pfErrorCode che possono essere restituiti da SQLInstallerError e spiega ognuno nel contesto di questa funzione.

*pfErrorCode	Errore	Descrizione
ODBC_ERROR_GENERAL_ERR	Errore generale del programma di installazione	Si è verificato un errore per il quale non si è verificato un errore specifico del programma di installazione.
ODBC_ERROR_OUT_OF_MEM	Memoria insufficiente	Il programma di installazione non è riuscito a eseguire la funzione a causa di una mancanza di memoria.

Commenti

SQLGetPrivateProfileString viene fornito come modo semplice per convertire i driver e le DLL di installazione dei driver da Microsoft Windows a Microsoft Windows NT/Windows 2000. Le chiamate a GetPrivateProfileString che recuperano una stringa di profilo dal file Odbc.ini devono essere sostituite con le chiamate a SQLGetPrivateProfileString. SQLGetPrivateProfileString chiama le funzioni nell'API Win32 per recuperare i nomi richiesti di valori o dati corrispondenti a un valore della sottochiave Odbc.ini delle informazioni di sistema.

La modalità di configurazione (impostata da SQLSetConfigMode) indica dove il Odbc.ini voce che elenca i valori DSN si trova nelle informazioni di sistema. Se il DSN è un DSN utente (la modalità di configurazione è U edizione Standard RDSN_ONLY), la funzione legge dalla voce Odbc.ini in HKEY_CURRENT_U edizione Standard R. Se il DSN è un DSN di sistema (SYSTEMDSN_ONLY), la funzione legge dalla voce Odbc.ini in HKEY_LOCAL_MACHINE. Se la modalità di configurazione è BOTHDSN, HKEY_CURRENT_U edizione Standard R viene tentata e, in caso di errore, viene usata HKEY_LOCAL_MACHINE.

Funzioni correlate

Per informazioni su	Vedere
Scrittura di un valore nelle informazioni di sistema	SQLWritePrivateProfileString