IMetabaseObjectDescriptors.RemoveByKey

Syntax

RemoveByKey(Key: Integer): Boolean;

Parameters

Key - key of the object description.

Description

The RemoveByKey method removes the description of the object from the collection by its key. The method returns True if removal is successful.

Comments

In the following implementation this method is available only for the manipulation of the collection of objectsnbsp;that are copied with the time series database.

Example

Executing the example requires that the repository contains a replication object with the CubeMetaUpd identifier.

Sub Main;

Var

Mb: IMetabase;

u: ICubeMetaUpdateEx;

Rub: IRubricator;

ObjectsFilter: IMetabaseObjectDescriptors;

MSKey: String;

Begin

Mb := MetabaseClass.Active;

u := Mb.ItemById("CubeMetaUpd").Edit As ICubeMetaUpdateEx;

Rub := u.Rubricator;

MSKey := Rub.Container(RubricatorContainerType.Data).Key;

ObjectsFilter := u.ObjectsFilter;

If ObjectsFilter.Count > 0 Then

Debug.WriteLine(ObjectsFilter.RemoveByKey(MSKey));

End If;

End Sub Main;

After executing the example, the data folder in the replication object is removed from the collection of the nested objects of time series database being copied.

See also:

IMetabaseObjectDescriptors