--- title: "Интерфейс массива удаленных индексов для операций копирования и массивов компонентов (ksDeletedCopyCollection и IDeletedCopyCollection)" type: interface api: [api7] domain: [2d, assembly, feature] tags: [interface, api7, 2d, assembly, feature, ksdeletedcopycollection] sources: - ksdeletedcopycollection.html --- *API интерфейсов. Версия 5 > Документ-модель (Интерфейсы - ksDocument3D, IDocument3D )  > Компонент сборки (деталь или подсборка). Интерфейсы ksPart и IPart  > Объект модели (Интерфейсы ksEntity и IEntity)  > Интерфейсы ksEntity и iEntity - Интерфейс элемента модели (оси, плоскости, формообразующего элемента)  > Интерфейсы копирования * ## Интерфейс массива удаленных индексов для операций копирования и массивов компонентов (ksDeletedCopyCollection и IDeletedCopyCollection) | ksDeletedCopyCollection | - интерфейс Automation | | --- | --- | | IDeletedCopyCollection | - интерфейс COM | Примечание: 1. Интерфейс применяется для массивов компонентов и операций копирования, для получения информации о удаленных копиях, а также управления составом удаленных копий. Информация о удаленной копии выдается в виде индексов копии в узоре копирования. В общем случае это два индекса по ортогональным осям в плоскости узора. Для копий по кривой используется один индекс (первый). Значения индексов начинаются с 1. 2. Данный интерфейс можно получить от следующих интерфейсов: •Интерфейсы копирования компонентов сборки. •Интерфейсы копирования. ## Add - Добавить объект в конец массива Синтаксис Automation: ``` BOOL Add (long index1, long index2); ``` Синтаксис COM: ``` BOOL GetByIndex (long index, long * index1, long * index2); Входные параметры: index1, index2 - индексы удаленной копии в узоре. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## AddAt - Добавить элемент перед элементом с заданным индексом Синтаксис Automation: ``` BOOL AddAt (long index1, long index2, long index); ``` Синтаксис COM: ``` BOOL AddAt (long index1, long index2, long index); Входные параметры: index1, index2 - индексы удаленной копии в узоре, index - удаленной копии в массиве. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## Clear - Очистить массив Синтаксис Automation: ``` BOOL Clear(); ``` Синтаксис COM: ``` BOOL Clear(); Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## DetachByBody - Отсоединить элемент Синтаксис Automation: ``` BOOL DetachByBody (long index1, long index2); ``` Синтаксис COM: ``` BOOL DetachByBody (long index1, long index2); Входные параметры: index1, index2 - индексы удаленной копии в узоре. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## DetachByIndex - Отсоединить элемент по индексу Синтаксис Automation: ``` BOOL DetachByIndex (long index); ``` Синтаксис COM: ``` BOOL DetachByIndex (long index); Входной параметр: index - индекс удаленной копии в массиве. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` Примечание: Элемент массива из модели не удаляется. ## FindIt - Получить индекс элемента в массиве Синтаксис Automation: ``` long FindIt (long index1, long index2); Возвращаемое значение: индекс элемента - если элемент найден в массиве, -1 - если элемент не найден. ``` Синтаксис COM: ``` unsigned long FindIt ( long index1, long index2); Возвращаемое значение: индекс элемента - если элемент найден в массиве, 0xffffffff - если элемент не найден. Входные параметры: index1, index2 - индексы удаленной копии в узоре. ``` ## First - Получить индексы первой удаленной копии Синтаксис Automation: ``` BOOL First(long * index1, long * index2); ``` Синтаксис COM: ``` BOOL First(long * index1, long * index2); Выходные параметры: index1, index2 - индексы удаленной копии в узоре. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## GetByIndex - Получить индексы удаленной копии по индексу Синтаксис Automation: ``` BOOL GetByIndex (long index, long * index1, long * index2); ``` Синтаксис COM: ``` BOOL GetByIndex (long index, long * index1, long * index2); Входной параметр: index - индекс удаленной копии в массиве. Выходные параметры: index1, index2 - индексы удаленной копии в узоре. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## GetCount - Получить количество элементов в массиве Синтаксис Automation: ``` long GetCount(); ``` Синтаксис COM: ``` long GetCount(); Возвращаемое значение: - количество элементов массива. ``` ## Last - Получить индексы последней удаленной копии Синтаксис Automation: ``` BOOL Last (long * index1, long * index2); ``` Синтаксис COM: ``` BOOL Last (long * index1, long * index2); Выходные параметры: index1, index2 - индексы удаленной копии в узоре. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## Next - Получить индексы следующей удаленной копии Синтаксис Automation: ``` BOOL Next (long * index1, long * index2); ``` Синтаксис COM: ``` BOOL Next (long * index1, long * index2); Выходные параметры: index1, index2 - индексы удаленной копии в узоре. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## Prev - Получить индексы предыдущей удаленной копии Синтаксис Automation: ``` BOOL Prev (long * index1, long * index2); ``` Синтаксис COM: ``` BOOL Prev (long * index1, long * index2); Выходные параметры: index1, index2 - индексы удаленной копии в узоре. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## Refresh - Обновить массив Синтаксис Automation: ``` BOOL Refresh(); ``` Синтаксис COM: ``` BOOL Refresh(); Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ``` ## SetByIndex - Заменить элемент Синтаксис Automation: ``` BOOL SetByIndex (long index1, long index2, long index); ``` Синтаксис COM: ``` BOOL SetByIndex (long index1, long index2, long index); Входные параметры: index1, index2 - индексы удаленной копии в узоре, index - удаленной копии в массиве. Возвращаемое значение: TRUE - в случае успешного завершения, FALSE - в случае неудачи. ```