Приложения

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

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

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

А.5.6.21. rdsGetChildBlockByName – блок подсистемы по имени

Функция rdsGetChildBlockByName возвращает идентификатор блока с заданным именем в заданной подсистеме.

  RDS_BHANDLE RDSCALL rdsGetChildBlockByNameA(
    RDS_BHANDLE Parent,          // Подсистема
    RDSCSTR Name,                // Имя блока (UTF8)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание блока
  );
  RDS_BHANDLE RDSCALL rdsGetChildBlockByNameW(
    RDS_BHANDLE Parent,          // Подсистема
    RDSWCSTR Name,               // Имя блока (UTF16)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание блока
  );
  // Функция-псевдоним
  RDS_BHANDLE RDSCALL rdsGetChildBlockByName(
    RDS_BHANDLE Parent,          // Подсистема
    RDSXCSTR Name,               // Имя блока (кодировка по умолчанию)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание блока
  );

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

RDS_BhBhSBd (для UTF8) или RDS_BhBhWsBd (для UTF16)

Параметры

Parent (RDS_BHANDLE)

Идентификатор подсистемы, в которой нужно найти блок.

Name (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель (char* или wchar_t*, в зависимости от версии функции) на строку с именем блока.

pDescr (RDS_PBLOCKDESCRIPTION)

Указатель на заполняемую функцией структуру описания найденного блока RDS_BLOCKDESCRIPTION. Если вызывающей программе не нужно это описание, в этом параметре можно передать NULL.

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

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

Примечания

Эта функция ищет в подсистеме Parent блок с именем Name. В отличие от функции rdsBlockByFullName, которая ищет блок в схеме по полному имени, она ищет блок только в конкретной подсистеме по его собственному имени, в которое, в отличие от полного, не входит вся цепочка подсистем от корневой до родительской данного блока.

Пример

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

См. также

rdsBlockByFullName.