Приложения

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

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

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

А.5.6.6. rdsCreateBlockFromFile – загрузить блок из файла

Функция rdsCreateBlockFromFile загружает блок из файла и вставляет его в заданную подсистему.

  RDS_BHANDLE RDSCALL rdsCreateBlockFromFileA(
    RDSCSTR FilePath,            // Путь к файлу (UTF8)
    RDS_BHANDLE Parent,          // Подсистема
    int x,int y,                 // Координаты
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );
  RDS_BHANDLE RDSCALL rdsCreateBlockFromFileW(
    RDSWCSTR FilePath,           // Путь к файлу (UTF16)
    RDS_BHANDLE Parent,          // Подсистема
    int x,int y,                 // Координаты
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );
  // Функция-псевдоним
  RDS_BHANDLE RDSCALL rdsCreateBlockFromFile(
    RDSXCSTR FilePath,           // Путь к файлу (кодировка по умолчанию)
    RDS_BHANDLE Parent,          // Подсистема
    int x,int y,                 // Координаты
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );

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

RDS_BhSBhIIBd (для UTF8) или RDS_BhWsBhIIBd (для UTF16)

Параметры

FilePath (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с именем файла. Имя файла может содержать как полный путь, так и сокращенный (с символическими обозначениями путей). В качестве файла блока можно указать файл схемы, тогда эта схема будет добавлена в загруженную схему как подсистема.
Parent (RDS_BHANDLE): Идентификатор подсистемы, внутрь которой нужно добавить блок.
x, y (int): Координаты точки привязки загружаемого блока на рабочем поле подсистемы Parent в масштабе 100%.
pDescr (RDS_PBLOCKDESCRIPTION): Указатель на структуру описания блока RDS_BLOCKDESCRIPTION, которую функция должна заполнить параметрами добавленного блока. Если вызывающей программе не нужно описание блока, в этом параметре можно передать NULL.

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

Идентификатор (RDS_BHANDLE) добавленного в подсистему блока или NULL в случае ошибки.

Примечания

Эта функция загружает блок из файла и вставляет его в подсистему Parent. В параметре FilePath можно указать путь к файлу сохраненного блока (обычно они имеют расширение «.blk», в таких файлах хранятся блоки в библиотеке и панели блоков RDS, см. §2.5 описания пользователя и §1.1 руководства программиста) или файлу сохраненной схемы (с расширением «.rds») – в последнем случае сохраненная схема станет внутренней подсистемой в Parent. Точкой привязки загруженного блока (для блоков с векторной картинкой – положением начала координат этой картинки, для программно рисуемых блоков и блоков, изображаемых прямоугольником с текстом – координатами левого верхнего угла изображения) станут значения из параметров x и y.

Следует помнить, что новый блок может быть добавлен в схему не немедленно: если в данный момент идет расчет, добавление будет отложено до конца очередного такта.

Пример

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

См. также

rdsDuplicateBlock, rdsDeleteBlock.