IMetabaseObjectDescriptors.RemoveByKey

Синтаксис

RemoveByKey(Key: Integer): Boolean;

RemoveByKey(Key: uinteger): boolean;

Параметры

Key. Ключ описания объекта.

Описание

Метод RemoveByKey удаляет описание объекта из коллекции по его ключу. Метод возвращает значение True, если удаление прошло успешно.

Комментарии

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

Пример

Для выполнения примера предполагается наличие в репозитории объекта репликации с идентификатором «CUBE_META_UPD».

Добавьте ссылки на системные сборки: Cubes, Metabase.

Sub UserProc;
Var
    Mb: IMetabase;
    u: ICubeMetaUpdateEx;
    ObjectsFilter: IMetabaseObjectDescriptors;
    MSKey: Integer;
Begin
    Mb := MetabaseClass.Active;
    u := Mb.ItemById("CUBE_META_UPD").Edit As ICubeMetaUpdateEx;
    ObjectsFilter := u.ObjectsFilter;
    If ObjectsFilter.Count > 0 Then
        Debug.WriteLine(ObjectsFilter.RemoveByKey(MSKey));
    End If;
End Sub UserProc;
Imports Prognoz.Platform.Interop.Cubes;
 
Public Shared Sub Main(Params: StartParams);
Var
    Mb: IMetabase;
    u: ICubeMetaUpdateEx;
    ObjectsFilter: IMetabaseObjectDescriptors;
    MSKey: UInteger;
Begin
    Mb := Params.Metabase;
    u := Mb.ItemById["CUBE_META_UPD"].Edit() As ICubeMetaUpdateEx;
    ObjectsFilter := u.ObjectsFilter;
    If ObjectsFilter.Count > 0 Then
        System.Diagnostics.Debug.WriteLine(ObjectsFilter.RemoveByKey(MSKey));
    End If;
End Sub;

После выполнения примера в объекте репликации из коллекции копируемых вложенных объектов базы данных временных рядов будет удалена папка данных.

См. также:

IMetabaseObjectDescriptors