Приложения
Приложение А. Функции, константы и структуры RDS
А.5. Сервисные функции и макросы RDS
А.5.34. Отладочные функции
А.5.34.2. rdsdebugBlockInfo – информация о блоке
Функция rdsdebugBlockInfo выводит в файл или сообщает пользователю тип, имя и координаты указанного в ее параметрах блока.
void RDSCALL rdsdebugBlockInfoA( RDS_BHANDLE Block, // Идентификатор блока RDSCSTR LogFile, // Имя файла или NULL (UTF8) RDSCSTR Caption // Заголовок (UTF8) ); void RDSCALL rdsdebugBlockInfoW( RDS_BHANDLE Block, // Идентификатор блока RDSWCSTR LogFile, // Имя файла или NULL (UTF16) RDSWCSTR Caption // Заголовок (UTF16) ); // Функция-псевдоним void RDSCALL rdsdebugBlockInfo( RDS_BHANDLE Block, // Идентификатор блока RDSXCSTR LogFile, // Имя файла или NULL (кодировка по умолчанию) RDSXCSTR Caption // Заголовок (кодировка по умолчанию) );
Тип указателя на эту функцию
RDS_VBhSS (для UTF8) или RDS_VBhWsWs (для UTF16)
Параметры
- Block (RDS_BHANDLE)
- Идентификатор блока, информация о котором запрашивается.
- LogFile (RDSCSTR, RDSWCSTR, RDSXCSTR)
- Указатель на строку с именем текстового файла, в конец которого нужно добавить информацию о блоке (см. rdsdebugLogString), или NULL, если нужно вывести эту информацию в окне сообщения (см. rdsMessageBox). Имя файла может содержать символические обозначения стандартных папок RDS. Если в имени файла нет пути, он будет считаться находящимся в одной папке с загруженной схемой.
- Caption (RDSCSTR, RDSWCSTR, RDSXCSTR)
- Указатель на дополнительный текст, который выводится в файл перед информацией о блоке (при LogFile!=NULL) или служит заголовком окна сообщения (при LogFile==NULL). В этом параметре можно передать NULL, если дополнительный текст или заголовок сообщения не нужны.
Примечания
Эта функция может быть полезна при отладке моделей блоков: если в схеме несколько блоков с одной и той же проблемной моделью, в ней можно вызывать rdsdebugBlockInfo при обнаружении ошибки или при наступлении какого-либо события – это даст понять, модель какого именно блока вызвана.
См. также