Приложения

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

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

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

Описываются функции, облегчающие вывод информации при отладке моделей блоков.

А.5.34.1. rdsBlockMessageBox – вывести окно сообщения с указанием имени блока

Функция rdsBlockMessageBox выводит стандартное окно сообщения Windows, добавляя к переданному в параметрах тексту сообщения полное имя указанного блока.

  int RDSCALL rdsBlockMessageBoxA(
    RDS_BHANDLE Block, // Идентификатор блока
    RDSCSTR Text,      // Текст сообщения (UTF8)
    RDSCSTR Caption,   // Заголовок окна сообщения (UTF8)
    int Flags          // Флаги Windows API (MB_*)
  );
  int RDSCALL rdsBlockMessageBoxW(
    RDS_BHANDLE Block, // Идентификатор блока
    RDSWCSTR Text,     // Текст сообщения (UTF16)
    RDSWCSTR Caption,  // Заголовок окна сообщения (UTF16)
    int Flags          // Флаги Windows API (MB_*)
  );
  // Функция-псевдоним
  int RDSCALL rdsBlockMessageBox(
    RDS_BHANDLE Block, // Идентификатор блока
    RDSXCSTR Text,     // Текст сообщения (кодировка по умолчанию)
    RDSXCSTR Caption,  // Заголовок окна сообщения (кодировка по умолчанию)
    int Flags          // Флаги Windows API (MB_*)
  );

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

RDS_IBhSSI (для UTF8) или RDS_IBhWsWsI (для UTF16)

Параметры

Block (RDS_BHANDLE)

Идентификатор блока, полное имя которого нужно добавить к тексту сообщения. Может иметь значение NULL, в этом случае имя блока к сообщению добавлено не будет.

Text (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с текстом выводимого сообщения. Сообщение может состоять из нескольких строк, разделенных символом перевода строки «\n» (код 10).

Caption (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с заголовком окна выводимого сообщения.

Flags (int)

Битовые флаги сообщения, определяющие набор кнопок в окне, иконку сообщения и т.п. Эти флаги совпадают с флагами стандартной функции Windows API MessageBox и сервисной функции rdsMessageBox.

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

Стандартная константа Windows API, указывающая на нажатую пользователем кнопку окна сообщения. Если сообщение выведено в режиме расчета, всегда возвращается константа IDCANCEL.

Примечания

Для вывода сообщения функция rdsBlockMessageBox неявно вызывает сервисную функцию rdsMessageBox, добавляя первой строкой к тексту сообщения Text слово «Блок:», за которым следует полное имя блока Block с указанием всей иерархии подсистем, в которой он находится. Если в параметре Block передан идентификатор корневой подсистемы, первой строкой выводится текст «Система».

Эта функция, в основном, применяется при отладке моделей для вывода различных диагностических сообщений. Ее параметры и возвращаемое значение более подробно рассмотрены в описании более общей функции rdsMessageBox.

См. также

rdsMessageBox.