Приложения

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

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

А.5.34. Отладочные функции

А.5.34.4. rdsSetDebugText – установить отладочный текст

Функция rdsSetDebugText устанавливает или очищает дополнительный текст, выводящийся в стандартном сообщении RDS о неустранимой ошибке.

  void RDSCALL rdsSetDebugTextA(
    RDSCSTR String,  // Текст (UTF8)
    BOOL Clear       // Установить (TRUE) или добавить (FALSE)
  );
  void RDSCALL rdsSetDebugTextW(
    RDSWCSTR String, // Текст (UTF16)
    BOOL Clear       // Установить (TRUE) или добавить (FALSE)
  );
  // Функция-псевдоним
  void RDSCALL rdsSetDebugText(
    RDSXCSTR String, // Текст (кодировка по умолчанию)
    BOOL Clear       // Установить (TRUE) или добавить (FALSE)
  );

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

RDS_VSB (для UTF8) или RDS_VWsB (для UTF16)

Параметры

String (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с текстом, или NULL, если нужно очистить текст.

vv (BOOL)

TRUE – текстом String нужно заменить прежний отладочный текст, FALSE – текст String нужно добавить в конец уже имеющегося.

Примечания

Эта функция обычно используется при отладке моделей блоков для конкретизации выводимого RDS сообщения о неустранимой ошибке. Перед подозрительной операцией можно установить поясняющий текст, а после нее – сбросить, например:

  // Установка текста
  rdsSetDebugTextW(L"Вызов SomeFunction",TRUE);
  // Выполнение подозрительной операции
  SomeFunction();
  // Сброс текста
  rdsSetDebugText(NULL,TRUE);

Если в этом примере неустранимая ошибка возникнет в функции SomeFunction, в сообщении об этой ошибке будет присутствовать текст «Вызов SomeFunction».

См. также