Приложения

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

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

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

А.5.27.6. rdsINIReadString – получить текст значения параметра

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

  RDSCSTR RDSCALL rdsINIReadStringA( // UTF8
    RDS_HOBJECT Ini,   // Объект
    RDSCSTR Key,       // Имя параметра (UTF8)
    RDSCSTR DefValue,  // Значение по умолчанию (UTF8)
    int *pLength       // Возвращаемая длина строки
  );
  RDSWCSTR RDSCALL rdsINIReadStringW( // UTF16
    RDS_HOBJECT Ini,   // Объект
    RDSWCSTR Key,      // Имя параметра (UTF16)
    RDSWCSTR DefValue, // Значение по умолчанию (UTF16)
    int *pLength       // Возвращаемая длина строки
  );
  // Функция-псевдоним
  RDSXCSTR RDSCALL rdsINIReadString( // Кодировка по умолчанию
    RDS_HOBJECT Ini,   // Объект
    RDSXCSTR Key,      // Имя параметра (кодировка по умолчанию)
    RDSXCSTR DefValue, // Значение по умолчанию (кодировка по умолчанию)
    int *pLength       // Возвращаемая длина строки
  );

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

RDS_SHoSSpI (для UTF8) или RDS_WsHoWsWspI (для UTF16)

Параметры

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

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

Указатель на строку значения параметра Key из текущей секции объекта Ini, находящуюся во внутренней памяти объекта. Вызывающая программа не должна изменять эту строку. Функция может вернуть NULL, если Ini – не объект для работы с текстом, или если вместо имени параметра передано значение NULL.

Примечания

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

Пример

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

См. также

rdsINICreateTextHolder, rdsINIWriteString, rdsINIReadDouble, rdsINIReadInt, rdsINIOpenSection, RDS_HINI_CREATESECTION.