Compartir a través de

Función SQLWriteFileDSN

  • Artículo

Conformidad
Versión introducida: ODBC 3.0

Resumen
SQLWriteFileDSN escribe información en un DSN de archivo.

Sintaxis

  
BOOL SQLWriteFileDSN(  
     LPCSTR     lpszFileName,  
     LPCSTR     lpszAppName,  
     LPCSTR     lpszKeyName,  
     LPCSTR     lpszString);

Argumentos

lpszFileName
[Entrada] Puntero al nombre del DSN de archivo. Una extensión DSN se anexa a todos los nombres de archivo que aún no tienen una extensión DSN.

lpszAppName
[Entrada] Puntero al nombre de la aplicación. Se trata de "ODBC" para la sección ODBC.

lpszKeyName
[Entrada] Puntero al nombre de la clave que se va a leer. Consulte "Comentarios" para obtener palabras clave reservadas.

lpszString
[Salida] Apunta a la cadena asociada a la clave que se va a escribir. La longitud máxima de la cadena a la que apunta este argumento es de 32 767 bytes.

Devoluciones

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

Diagnóstico

Cuando SQLWriteFileDSN 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 de ellos en el contexto de esta función.

*pfErrorCode Error Descripción
ODBC_ERROR_GENERAL_ERR Error general del instalador Se produjo un error para el que no hubo ningún error de instalador específico.
ODBC_ERROR_INVALID_PATH Ruta de instalación no válida La ruta de acceso del nombre de archivo especificado en el argumento lpszFileName no era válida.
ODBC_ERROR_INVALID_REQUEST_TYPE Tipo de solicitud no válido El argumento lpszAppName, lpszKeyName o lpszString era NULL.

Comentarios

ODBC reserva el nombre de sección [ODBC] en el que almacenar la información de conexión. Las palabras clave reservadas para esta sección son las mismas que las reservadas para una cadena de conexión en SQLDriverConnect. (Para obtener más información, vea la descripción de la función SQLDriverConnect ).

Las aplicaciones pueden usar estas palabras clave reservadas para escribir información directamente en un DSN de archivo. Si una aplicación desea crear o modificar la cadena de conexión sin DSN asociada a un DSN de archivo, puede llamar a SQLWriteFileDSN para cualquiera de las palabras clave de cadena de conexión reservadas de la sección [ODBC].

Si el argumento lpszString es un puntero nulo, la palabra clave a la que apunta el argumento lpszKeyName se eliminará del archivo .dsn. Si los argumentos lpszString y lpszKeyName son punteros NULOs, la sección a la que apunta el argumento lpszAppName se eliminará del archivo .dsn.

Para información acerca de Vea
Leer información de DSN de archivo SQLReadFileDSN