Приложения

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

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

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

А.5.6.3. rdsBlockByFullName – блок по его полному имени

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

  RDS_BHANDLE RDSCALL rdsBlockByFullNameA(
    RDSCSTR FullName,            // Полное имя блока (UTF8)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );
  RDS_BHANDLE RDSCALL rdsBlockByFullNameW(
    RDSWCSTR FullName,           // Полное имя блока (UTF16)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );
  // Функция-псевдоним
  RDS_BHANDLE RDSCALL rdsBlockByFullName(
    RDSXCSTR FullName,           // Полное имя блока (кодировка по умолчанию)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );

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

RDS_BhSBd (для UTF8) или RDS_BhWsBd (для UTF16)

Параметры

FullName (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с полным именем блока. Полное имя блока начинается с двоеточия, за которым следует последовательное перечисление через двоеточие всех имен подсистем на пути от корневой подсистемы до этого блока, которое завершается именем самого блока. Например, полное имя «:Sys1:Sys100:Block1» говорит о том, что блок с именем «Block1» находится в подсистеме «Sys100», которая, в свою очередь, находится в подсистеме «Sys1» корневой подсистемы.
pDescr (RDS_PBLOCKDESCRIPTION): Указатель на структуру описания блока RDS_BLOCKDESCRIPTION, которую функция должна заполнить параметрами найденного блока. Если вызывающей программе не нужно описание блока, в этом параметре можно передать NULL.

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

Уникальный идентификатор найденного блока (RDS_BHANDLE) или NULL, если блока с таким именем нет в загруженной в данный момент схеме.

Примечания

Эта функция позволяет по строке полного имени блока, уникальной для любого блока схемы, получить идентификатор этого блока, который можно использовать в других сервисных функциях для выполнения с этим блоком каких-либо действий. Для поиска блока по имени в конкретной подсистеме следует использовать другую функцию – rdsGetChildBlockByName.

См. также

RDS_BLOCKDESCRIPTION, rdsBlockOrConnByExtId, rdsCreateFullBlockNameString, rdsGetChildBlockByName.