Приложения

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

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

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

А.5.6.45. rdsSetBlockComment – задать комментарий блока

Функция rdsSetBlockComment устанавливает текст комментария указанного блока.

  void RDSCALL rdsSetBlockCommentA(
    RDS_BHANDLE Block, // Блок
    RDSCSTR Comment    // Текст комментария (UTF8)
  );
  void RDSCALL rdsSetBlockCommentW(
    RDS_BHANDLE Block, // Блок
    RDSWCSTR Comment   // Текст комментария (UTF16)
  );
  // Функция-псевдоним
  void RDSCALL rdsSetBlockComment(
    RDS_BHANDLE Block, // Блок
    RDSXCSTR Comment   // Текст комментария (кодировка по умолчанию)
  );

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

RDS_VBhS (для UTF8) или RDS_VBhWs (для UTF16)

Параметры

Block (RDS_BHANDLE)

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

Comment (RDSCSTR, RDSWCSTR, RDSXCSTR)

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

Примечания

Комментарий блока редко используется в моделях. Он может быть как угодно изменен пользователем в окне параметров блока, и, чаще всего, модель блока не вмешивается в процесс его редактирования. Тем не менее, комментарий можно использовать для добавления к блоку каких-либо пометок, которые пользователь сможет легко найти и прочесть. Иногда, для самых простых блоков, комментарий используется для хранения текстовых параметров – в этом случае можно не делать специальный интерфейс для ввода этих параметров, но нужно обязать пользователя заполнять комментарий определенным, заранее оговоренным способом.

Пример

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

См. также

RDS_BLOCKDESCRIPTION, rdsGetBlockDescription.