Приложения

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

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

А.5.26. Вспомогательный объект для разбора текста

А.5.26.2. rdsSTRAddKeyword – добавление ключевого слова

Функция rdsSTRAddKeyword добавляет в объект разбора текста ключевое слово с целым идентификатором. В процессе разбора текста при совпадении очередного слова с этим ключевым словом объект будет возвращать его идентификатор.

  int RDSCALL rdsSTRAddKeywordA(
    RDS_HOBJECT Parser, // Объект
    RDSCSTR Keyword,    // Ключевое слово (UTF8)
    int Id              // Идентификатор
  );
  int RDSCALL rdsSTRAddKeywordW(
    RDS_HOBJECT Parser, // Объект
    RDSWCSTR Keyword,   // Ключевое слово (UTF16)
    int Id              // Идентификатор
  );
  // Функция-псевдоним
  int RDSCALL rdsSTRAddKeyword(
    RDS_HOBJECT Parser, // Объект
    RDSXCSTR Keyword,   // Ключевое слово (кодировка по умолчанию)
    int Id              // Идентификатор
  );

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

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

Параметры

Parser (RDS_HOBJECT)

Идентификатор вспомогательного объекта для разбора текста, ранее созданного функцией rdsSTRCreateTextReader.

Keyword (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с ключевым словом.

Id (int)

Целый идентификатор ключевого слова Keyword.

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

Если ключевого слова Keyword еще не было в объекте Parser, функция вернет переданный ей идентификатор Id. Если это слово уже было добавлено в объект, функция вернет идентификатор, который этому слову присвоили при первом добавлении. Если же в параметре Keyword передано значение NULL или указатель на пустую строку, или если Parser – не объект разбора текста, функция вернет −1.

Примечания

Эта функция добавляет во внутренний набор ключевых слов объекта Parser новое слово Keyword и присваивает ему идентификатор Id. Если при извлечении слов из произвольного текста функцией rdsSTRGetWord слово совпадет с Keyword, объект вернет вызвавшей программе значение Id.

См. также

rdsSTRCreateTextReader, rdsSTRAddKeywordsArray, rdsSTRGetWord.