Приложения

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

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

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

А.5.22.3. rdsCommandObjectEx – команда объекту

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

  BOOL RDSCALL rdsCommandObjectEx(
    RDS_HOBJECT Object,  // Идентификатор объекта
    int ObjCmd,          // Команда
    int CmdParam,        // Параметр команды
    int *pResult         // Возвращаемый результат
  );

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

RDS_BHoIIpI

Параметры

Object (RDS_HOBJECT): Идентификатор вспомогательного объекта RDS, который должен выполнить команду.
ObjCmd (int): Идентификатор команды. Разные объекты поддерживают разные команды, допустимые идентификаторы команд перечислены в описании каждого объекта.
CmdParam (int): Параметр команды, если он нужен. Если у команды ObjCmd нет параметра, значение CmdParam игнорируется.
pResult (int*): Указатель на целую переменную, в которую функция запишет целый результат выполнения команды, если команда ObjCmd возвращает целое число. Если результат команды не нужен вызывающей программе, в этом параметре можно передать NULL.

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

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

Примечания

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

Если у команды нет параметра, и она не возвращает целое число, вместо rdsCommandObjectEx можно использовать более простую функцию rdsCommandObject.

Пример

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

См. также

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