Приложения

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

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

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

А.5.6.42. rdsRenameBlock – переименовать блок

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

  BOOL RDSCALL rdsRenameBlockA(
    RDS_BHANDLE Block,           // Блок
    RDSCSTR NewName,             // Новое имя (UTF8)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );
  BOOL RDSCALL rdsRenameBlockW(
    RDS_BHANDLE Block,           // Блок
    RDSWCSTR NewName,            // Новое имя (UTF16)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );
  // Функция-псевдоним
  BOOL RDSCALL rdsRenameBlock(
    RDS_BHANDLE Block,           // Блок
    RDSXCSTR NewName,            // Новое имя (кодировка по умолчанию)
    RDS_PBLOCKDESCRIPTION pDescr // Заполняемое описание
  );

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

RDS_BBhSBd (для UTF8) или RDS_BBhWsBd (для UTF16)

Параметры

Block (RDS_BHANDLE): Идентификатор переименовываемого блока.
NewName (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку (char* или wchar_t*, в зависимости от версии функции) с новым именем блока.
pDescr (RDS_PBLOCKDESCRIPTION): Указатель на структуру описания блока RDS_BLOCKDESCRIPTION, которую функция должна заполнить параметрами блока после переименования. Если вызывающей программе не нужно описание блока, в этом параметре можно передать NULL.

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

TRUE, если блок переименован, FALSE в противном случае (например, в имени NewName содержатся недопустимые символы или блок с таким именем уже есть в подсистеме).

Примечания

Блок будет переименован только в том случае, если в его родительской подсистеме нет блока с именем NewName и в этом имени не содержатся недопустимые для имен блоков символы (см. §1.4 руководства программиста). После переименования блока его модель будет вызвана для реакции на событие RDS_BFM_RENAME в том же потоке, который вызвал rdsRenameBlock.

Пример

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

См. также

RDS_BLOCKDESCRIPTION, RDS_BFM_RENAME.