Приложения

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

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

А.5.6. Операции с блоками и связями

А.5.6.44. rdsSetBlockAltNameText – вывод текста вместо имени блока

Функция rdsSetBlockAltNameText устанавливает текст, который должен выводиться вместо имени указанного блока.

  void RDSCALL rdsSetBlockAltNameTextA(
    RDS_BHANDLE Block, // Блок
    RDSCSTR Text,      // Текст (UTF8)
    int Alignment      // Выравнивание (RDS_ALTBLKNAME_*)
  );
  void RDSCALL rdsSetBlockAltNameTextW(
    RDS_BHANDLE Block, // Блок
    RDSWCSTR Text,     // Текст (UTF16)
    int Alignment      // Выравнивание (RDS_ALTBLKNAME_*)
  );
  // Функция-псевдоним
  void RDSCALL rdsSetBlockAltNameText(
    RDS_BHANDLE Block, // Блок
    RDSXCSTR Text,     // Текст (кодировка по умолчанию)
    int Alignment      // Выравнивание (RDS_ALTBLKNAME_*)
  );

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

RDS_VBhSI (для UTF8) или RDS_VBhWsI (для UTF16)

Параметры

Block (RDS_BHANDLE)

Идентификатор блока.

Text (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку (char* или wchar_t*, в зависимости от версии функции), содержащую текст, который должен выводиться на рабочем поле вместо имени блока. Текст может состоять из нескольких строк – в этом случае строки отделяются друг от друга символом перевода строки «\n» (код 10). Для того, чтобы восстановить вывод имени блока, в этом параметре нужно передать NULL или указатель на пустую строку.

Alignment (int)

Выравнивание текста по горизонтали, если он состоит из нескольких строк:

RDS_ALTBLKNAME_LEFT	Строки выровнены по левому краю.
RDS_ALTBLKNAME_CENTER	Строки выровнены по центру.
RDS_ALTBLKNAME_RIGHT	Строки выровнены по правому краю.

Примечания

Обычно рядом с изображением блока на рабочем поле подсистемы выводится его имя, если вывод имен всех блоков или имени этого конкретного блока явно не отключен пользователем. Функция rdsSetBlockAltNameText позволяет вывести вместо имени блока произвольный текст, который, как и имя блока, будет отображаться под изображением, над изображением или в произвольном месте рабочего поля по желанию пользователя. В этом тексте может содержаться какая-либо информация о блоке, его условное название для пользователя и т.д. Этот текст никак не связан с именем блока и его изменение не приводит к переименованию блока. Для отмены вывода текста и возврата к выводу настоящего имени блока нужно вызвать эту же функцию, передав в параметре Text значение NULL или указатель на пустую строку.

См. также

RDS_BLOCKDESCRIPTION.