Приложения

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

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

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

А.5.22.5. rdsGetObjectArray – получить массив из объекта

Функция rdsGetObjectArray возвращает указатель на заданный массив в заданном объекте, если такой массив существует.

  LPVOID RDSCALL rdsGetObjectArray(
    RDS_HOBJECT Object,  // Идентификатор объекта
    int ObjOp,           // Команда (идентификатор массива)
    int OpParam,         // Дополнительный параметр
    int *pSize           // Возвращаемое число элементов
  );

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

RDS_pVHoIIpI

Параметры

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

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

Указатель общего вида (void*) на первый элемент массива, или NULL, если такого массива нет в объекте. Перед использованием этот указатель нужно будет привести к конкретному типу «указатель на тип элемента массива».

Примечания

Эта функция возвращает указатель на массив, содержащийся в объекте Object. Массив однозначно определяется парой целых чисел (ObjOp,OpParam) – конкретный смысл этих параметров зависит от назначения объекта Object. На данный момент только один вспомогательный объект RDS содержит в себе массивы – это объект для работы со списком блоков и связей, создаваемый функцией rdsBCLCreateList.

Пример

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

См. также

Вспомогательные объекты, rdsBCLCreateList, RDS_HBCL_BLOCKARRAY, RDS_HBCL_CONNARRAY.