Función SQLGetPrivateProfileString

Conformidad
Versión introducida: ODBC 2.0

Resumen
SQLGetPrivateProfileString obtiene una lista de nombres de valores o datos correspondientes a un valor de la información del sistema.

Sintaxis

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

Argumentos

lpszSection
[Entrada] Apunta a una cadena terminada en NULL que especifica la sección que contiene el nombre de clave. Si este argumento es NULL, la función copia todos los nombres de sección del archivo en el búfer proporcionado.

lpszEntry
[Entrada] Apunta a la cadena terminada en null que contiene el nombre de clave cuya cadena asociada se va a recuperar. Si este argumento es NULL, todos los nombres de clave de la sección especificados por el argumento lpszSection se copian en el búfer especificado por el argumento RetBuffer .

lpszDefault
[Entrada] Apunta a una cadena terminada en NULL que especifica el valor predeterminado de la clave especificada si no se encuentra la clave en el archivo de inicialización. Este argumento no puede ser NULL.

RetBuffer
[Salida] Apunta al búfer que recibe la cadena recuperada.

cbRetBuffer
[Entrada] Especifica el tamaño, en caracteres, del búfer al que apunta el argumento RetBuffer .

lpszFilename
[Entrada] Apunta a una cadena terminada en NULL que asigna un nombre al archivo de inicialización. Si este argumento no contiene una ruta de acceso completa al archivo, se busca en el directorio predeterminado.

Devoluciones

SQLGetPrivateProfileString devuelve un valor entero que indica el número de caracteres leídos.

Diagnóstico

Cuando se produce un error en una llamada a SQLGetPrivateProfileString, se puede obtener un valor *pfErrorCode asociado llamando a SQLInstallerError. En la tabla siguiente se enumeran los valores *pfErrorCode que SQLInstallerError puede devolver y explica cada uno en el contexto de esta función.

*pfErrorCode	Error	Descripción
ODBC_ERROR_GENERAL_ERR	Error general del instalador	Error para el que no se produjo ningún error específico del instalador.
ODBC_ERROR_OUT_OF_MEM	No hay memoria suficiente	El instalador no pudo realizar la función debido a una falta de memoria.

Comentarios

SQLGetPrivateProfileString se proporciona como una manera sencilla de portar controladores y configurar archivos DLL de controladores de Microsoft Windows a Microsoft Windows NT/Windows 2000. Las llamadas a GetPrivateProfileString que recuperan una cadena de perfil del archivo Odbc.ini deben reemplazarse por llamadas a SQLGetPrivateProfileString. SQLGetPrivateProfileString llama a las funciones de la API de Win32 para recuperar los nombres solicitados de valores o datos correspondientes a un valor de la subclave Odbc.ini de la información del sistema.

El modo de configuración (tal como lo establece SQLSetConfigMode) indica dónde se encuentra la Odbc.ini entrada que enumera los valores de DSN en la información del sistema. Si el DSN es un DSN de usuario (el modo de configuración es USERDSN_ONLY), la función lee de la entrada de Odbc.ini en HKEY_CURRENT_USER. Si el DSN es un DSN del sistema (SYSTEMDSN_ONLY), la función lee de la entrada de Odbc.ini en HKEY_LOCAL_MACHINE. Si el modo de configuración es BOTHDSN, se intenta HKEY_CURRENT_USER y, si se produce un error, se usa HKEY_LOCAL_MACHINE.

Funciones relacionadas

Para información acerca de	Vea
Escribir un valor en la información del sistema	SQLWritePrivateProfileString