Приложения

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

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

А.5.22. Общие функции вспомогательных объектов

А.5.22.2. rdsCommandObject – команда объекту

Функция rdsCommandObject передает указанному вспомогательному объекту команду с целым идентификатором. Это упрощенный вариант функции rdsCommandObjectEx.

  BOOL RDSCALL rdsCommandObject(
    RDS_HOBJECT Object,  // Идентификатор объекта
    int ObjCmd           // Команда
  );

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

RDS_BHoI

Параметры

Object (RDS_HOBJECT)

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

ObjCmd (int)

Идентификатор команды. Разные объекты поддерживают разные команды, допустимые идентификаторы команд перечислены в описании каждого объекта.

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

Логический результат выполнения команды. Если объект Object не поддерживает команду ObjCmd, функция возвращает FALSE. Если объект поддерживает команду, возвращаемое функцией значение зависит от выполнения данной команды.

Примечания

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

Вызов rdsCommandObject(Object,ObjCmd) полностью эквивалентен вызову rdsCommandObjectEx(Object,ObjCmd,0,NULL).

Пример

Примеры использования функции rdsCommandObject приведены в §2.7.3, §2.8.5, §2.16.2, §3.2 руководства программиста и др.

См. также

Вспомогательные объекты, rdsCommandObjectEx, rdsSetObjectDouble, rdsSetObjectInt, rdsSetObjectStr.