Función SQLWritePrivateProfileString

Conformidad
Versión introducida: ODBC 2.0

Resumen
SQLWritePrivateProfileString escribe un nombre de valor y datos en la subclave Odbc.ini de la información del sistema.

Sintaxis

  
BOOL SQLWritePrivateProfileString(  
     LPCSTR     lpszSection,  
     LPCSTR     lpszEntry,  
     LPCSTR     lpszString,  
     LPCSTR     lpszFilename);  

Argumentos

lpszSection
[Entrada] Apunta a una cadena terminada en NULL que contiene el nombre de la sección a la que se copiará la cadena. Si la sección no existe, se creará. El nombre de la sección es independiente de mayúsculas y minúsculas; la cadena puede ser cualquier combinación de letras mayúsculas y minúsculas.

lpszEntry
[Entrada] Apunta a una cadena terminada en NULL que contiene el nombre de la clave que se va a asociar a una cadena. Si la clave no existe en la sección especificada, se crea. Si este argumento es NULL, se elimina toda la sección, incluidas todas las entradas de la sección.

lpszString
[Entrada] Apunta a una cadena terminada en null que se va a escribir en el archivo. Si este argumento es NULL, se elimina la clave a la que apunta el argumento lpszEntry .

lpszFilename
[Salida] Apunta a una cadena terminada en NULL que asigna un nombre al archivo de inicialización.

Devoluciones

La función devuelve TRUE si se ejecuta correctamente, FALSE si se produce un error.

Diagnóstico

Cuando SQLWritePrivateProfileString devuelve FALSE, 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_REQUEST_FAILED	Error en la solicitud	No se pudo escribir la información del sistema solicitada.
ODBC_ERROR_OUT_OF_MEM	No hay memoria suficiente	El instalador no pudo realizar la función debido a una falta de memoria.

Comentarios

SQLWritePrivateProfileString 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 WritePrivateProfileString que escriben una cadena de perfil en el archivo Odbc.ini deben reemplazarse por llamadas a SQLWritePrivateProfileString. SQLWritePrivateProfileString llama a las funciones de la API de Win32 para agregar el nombre de valor y los datos especificados a la subclave Odbc.ini de la información del sistema.

Un modo de configuración indica dónde se encuentra en la información del sistema el Odbc.ini entrada que enumera los valores de DSN. Si el DSN es un DSN de usuario (la variable de estado es USERDSN_ONLY), la función escribe en la entrada de Odbc.ini en HKEY_CURRENT_USER. Si el DSN es un DSN del sistema (SYSTEMDSN_ONLY), la función escribe en la entrada Odbc.ini de HKEY_LOCAL_MACHINE. Si la variable de estado es BOTHDSN, se prueba HKEY_CURRENT_USER y, si se produce un error, se usa HKEY_LOCAL_MACHINE.

Funciones relacionadas

Para información acerca de	Vea
Obtención de un valor de la información del sistema	SQLGetPrivateProfileString