Поделиться через

Функция SQLWriteFileDSN

  • Статья

Соответствия
Представлена версия: ODBC 3.0

Сводка
SQLWriteFileDSN записывает сведения в dsN файла.

Синтаксис

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

Аргументы

lpszFileName
[Входные данные] Указатель на имя имени dsN файла. Расширение DSN добавляется ко всем именам файлов, которые еще не имеют расширения DSN.

lpszAppName
[Входные данные] Указатель на имя приложения. Это "ODBC" для раздела ODBC.

lpszKeyName
[Входные данные] Указатель на имя ключа для чтения. Дополнительные сведения см. в разделе "Комментарии" для зарезервированных ключевых слов.

lpszString
[Выходные данные] Указывает на строку, связанную с ключом для записи. Максимальная длина строки, на которую указывает этот аргумент, составляет 32 767 байт.

Возвраты

Функция возвращает значение TRUE, если оно выполнено успешно, значение FALSE, если оно завершается ошибкой.

Диагностика

Когда SQLWriteFileDSN возвращает ЗНАЧЕНИЕ FALSE, связанное значение *pfErrorCode можно получить путем вызова SQLInstallerError. В следующей таблице перечислены значения *pfErrorCode , которые можно возвращать SQLInstallerError и объясняет каждый из них в контексте этой функции.

*pfErrorCode Error Description
ODBC_ERROR_GENERAL_ERR Общая ошибка установщика Произошла ошибка, для которой не было определенной ошибки установщика.
ODBC_ERROR_INVALID_PATH Недопустимый путь установки Недопустимый путь имени файла, указанного в аргументе lpszFileName .
ODBC_ERROR_INVALID_REQUEST_TYPE Недопустимый тип запроса Аргумент lpszAppName, lpszKeyName или lpszString был NULL.

Комментарии

ODBC резервирует имя раздела [ODBC], в котором хранятся сведения о подключении. Зарезервированные ключевые слова для этого раздела совпадают с зарезервированными для строки подключения в SQLDriverConnect. (Дополнительные сведения см. в разделе Описание функции SQLDriverConnect .)

Приложения могут использовать эти зарезервированные ключевые слова для записи информации непосредственно в dsN файла. Если приложению нужно создать или изменить строку подключения, не связанную с доменным доменным доменом, можно вызвать SQLWriteFileDSN для любого из зарезервированных ключевых слов строки подключения в разделе [ODBC].

Если аргумент lpszString является пустым указателем, ключевое слово, указываемое аргументом lpszKeyName, будет удалено из dsn-файла. Если аргументы lpszString и lpszKeyName являются пустыми указателями, раздел, на который указывает аргумент lpszAppName, будет удален из DSN-файла.

Сведения Раздел
Чтение сведений из доменных имен файлов SQLReadFileDSN