Функция SQLGetPrivateProfileString

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

Сводка
SQLGetPrivateProfileString получает список имен значений или данных, соответствующих значению системной информации.

Синтаксис

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

Аргументы

lpszSection
[Входные данные] Указывает на строку, завершающую значение NULL, которая указывает раздел, содержащий имя ключа. Если этот аргумент имеет значение NULL, функция копирует все имена разделов в файл в предоставленный буфер.

lpszEntry
[Входные данные] Указывает на строку, завершающую значение NULL, содержащую имя ключа, связанная строка которого должна быть извлечена. Если этот аргумент имеет значение NULL, все имена ключей в разделе, указанном аргументом lpszSection, копируются в буфер, указанный аргументом RetBuffer.

lpszDefault
[Входные данные] Указывает на строку, завершающую значение NULL, указывающую значение по умолчанию для заданного ключа, если ключ не найден в файле инициализации. Этот аргумент не может иметь значение NULL.

RetBuffer
[Выходные данные] Указывает на буфер, получающий полученную строку.

cbRetBuffer
[Входные данные] Задает размер буфера в символах, на который указывает аргумент RetBuffer .

lpszFilename
[Входные данные] Указывает на строку, завершающую значение NULL, которая называет файл инициализации. Если этот аргумент не содержит полный путь к файлу, выполняется поиск каталога по умолчанию.

Возвраты

SQLGetPrivateProfileString возвращает целочисленное значение, указывающее количество операций чтения символов.

Диагностика

При сбое вызова SQLGetPrivateProfileString связанное значение *pfErrorCode можно получить путем вызова SQLInstallerError. В следующей таблице перечислены значения *pfErrorCode , которые можно возвращать SQLInstallerError и объясняет каждый из них в контексте этой функции.

*pfErrorCode	Ошибка	Описание
ODBC_ERROR_GENERAL_ERR	Общая ошибка установщика	Произошла ошибка, для которой не было определенной ошибки установщика.
ODBC_ERROR_OUT_OF_MEM	Недостаточно памяти	Установщик не мог выполнить функцию из-за нехватки памяти.

Комментарии

SQLGetPrivateProfileString предоставляется как простой способ переноса драйверов и библиотек DLL драйверов из Microsoft Windows в Microsoft Windows в Microsoft Windows NT/Windows 2000. Вызовы GetPrivateProfileString, которые извлекают строку профиля из файла Odbc.ini, следует заменить вызовами SQLGetPrivateProfileString. SqlGetPrivateProfileString вызывает функции в API Win32, чтобы получить запрошенные имена значений или данных, соответствующих значению Odbc.ini подраздела системной информации.

Режим конфигурации (как задано SQLSetConfigMode) указывает, где Odbc.ini записи, в которой перечислены значения DSN в системной информации. Если dsN является доменным доменом пользователя (режим конфигурации USERDSN_ONLY), функция считывается из записи Odbc.ini в HKEY_CURRENT_USER. Если dsN является системным доменным доменом (SYSTEMDSN_ONLY), функция считывается из записи Odbc.ini в HKEY_LOCAL_MACHINE. Если режим конфигурации имеет значение BOTHDSN, HKEY_CURRENT_USER пробуется, и при сбое используется HKEY_LOCAL_MACHINE.

Связанные функции

Сведения	Смотрите
Запись значения в системную информацию	SQLWritePrivateProfileString