Приложения

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

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

А.5.10. Загрузка и сохранение данных блока

А.5.10.6. rdsWriteColorText – запись цвета в текстовом формате

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

  void RDSCALL rdsWriteColorTextA(
    RDSCSTR Keyword,  // Ключевое слово (UTF8)
    COLORREF Color,   // Цвет
    BOOL Rgb          // Запись по компонентам
  );
  void RDSCALL rdsWriteColorTextW(
    RDSWCSTR Keyword, // Ключевое слово (UTF16)
    COLORREF Color,   // Цвет
    BOOL Rgb          // Запись по компонентам
  );
  // Функция-псевдоним
  void RDSCALL rdsWriteColorText(
    RDSXCSTR Keyword, // Ключевое слово (кодировка по умолчанию)
    COLORREF Color,   // Цвет
    BOOL Rgb          // Запись по компонентам
  );

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

RDS_VSCrB (для UTF8) или RDS_VWsCrB (для UTF16)

Параметры

Keyword (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку (char* или wchar_t*, в зависимости от версии функции) с ключевым словом, или NULL, если ключевое слово добавлять не нужно.

Сolor (COLORREF)

Значение цвета.

Rgb (BOOL)

Выводить цвет покомпонентно (TRUE) или одним числом (FALSE).

Примечания

Эта функция может вызываться только из функции модели блока в момент реакции на события записи данных блока в текстовом формате RDS_BFM_SAVETXT, во всех остальных случаях вызов игнорируется. Она добавляет описание цвета к общему набору текстовых данных блока, после завершения реакции на событие RDS_BFM_SAVETXT этот набор будет записан в файл или буфер обмена (в зависимости от того, для чего сохраняются данные блока). Перед описанием цвета всегда добавляется пробел.

Функция может описывать цвет двумя способами: покомпонентно с дополнительным словом «rgb», за которым следуют три числа интенсивности цвета по каналам (красный, затем зеленый, затем синий канал), или одним десятичным числом. Перед собственно описанием цвета можно добавить произвольное ключевое слово. Например:

Формат записи цвета, используемый в функции rdsWriteColorText, совместим с функцией rdsReadColorText и текстовым форматом схем RDS.

См. также

RDS_BFM_SAVETXT, RDS_BFM_LOADTXT, rdsReadColorText.