Приложения

Приложение А. Функции, константы и структуры RDS

А.5. Сервисные функции и макросы RDS

А.5.27. Вспомогательный объект для работы с текстом в формате INI-файла

А.5.27.5. rdsINIReadInt – получить целое значение параметра

Функция rdsINIReadInt считывает значение указанного параметра из текущей секции объекта и возвращает его в виде целого числа.

  int RDSCALL rdsINIReadIntA(
    RDS_HOBJECT Ini, // Объект
    RDSCSTR Key,     // Имя параметра (UTF8)
    int DefValue     // Значение по умолчанию
  );
  int RDSCALL rdsINIReadIntW(
    RDS_HOBJECT Ini, // Объект
    RDSWCSTR Key,    // Имя параметра (UTF16)
    int DefValue     // Значение по умолчанию
  );
  // Функция-псевдоним
  int RDSCALL rdsINIReadInt(
    RDS_HOBJECT Ini, // Объект
    RDSXCSTR Key,    // Имя параметра (кодировка по умолчанию)
    int DefValue     // Значение по умолчанию
  );

Тип указателя на эту функцию

RDS_IHoSI (для UTF8) или RDS_IHoWsI (для UTF16)

Параметры

Ini (RDS_HOBJECT): Идентификатор вспомогательного объекта для работы с текстом, ранее созданного функцией rdsINICreateTextHolder.
Key (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с именем параметра.
DefValue (int): Значение параметра по умолчанию (функция вернет это значение, если в текущей секции текста нет параметра с именем Key).

Возвращаемое значение

Целое значение параметра Key из текущей секции объекта Ini.

Примечания

Эта функция возвращает целое значение параметра с именем Key из текущей секции объекта Ini, если такой параметр есть в этой секции. Текущей считается секция, установленная функцией rdsINIOpenSection или командой RDS_HINI_CREATESECTION. Если в секции нет параметра с указанным именем или если текущая секция не установлена, функция вернет значение DefValue. Строка значения должна быть символьным представлением целого числа в десятичной системе счисления.

Пример

Пример использования функции rdsINIReadInt приведен в §2.8.5 руководства программиста.

См. также

rdsINICreateTextHolder, rdsINIWriteInt, rdsINIReadDouble, rdsINIReadString, rdsINIOpenSection, RDS_HINI_CREATESECTION.