RemoveManyFromDestCollection - Teradata Meta Data Services

RemoveManyFromDestCollection

Purpose

The CMetaObject class RemoveManyFromDestCollection function removes the specified list of object IDs from the collection of the specified object.

Description

The relationship ID is specified by the GUID relationship ID or the internal relationship ID (one must be set).

RemoveManyFromDestCollection only removes the current version of the destination objects from the collection of the current version of the CMetaObject. If necessary, RemoveFromDestCollection will determine the current version for the CMetaObject and each entry in lDestIDs.

If the destination class of the relationship is a superclass, the destIDList can contain IDs of objects of the destination class type and its subclasses.

Requirements

The ObjectID of the origin object must be set in the object and it must be for a version of the object. Each object id in lDestIDs must be for a version of an object.

Syntax

HRESULT RemoveManyFromDestCollection(

const LLOBJECTID_t &destIDlist, 

const GUID &gRelID, 

const OBJECTID_t lRelID = NULLLOID);

HRESULT RemoveManyFromDestCollection(

const LLOBJECTID_t &destIDlist, 

const GUID &gRelID, 

const OBJECTID_t lRelID,

const bool mergeList);

Argument	In/Out	Description
destIDList	In	List of ObjectIDs to remove from the destination collection.
gRelID	In	Relationship ID. Can be set to NULLGUID if lRelID is set.
lRelID	In (Optional)	Internal Relationship ID. Optional if gRelID is set.
mergeList	In	If true, IDs in the destIDList which are not in the collection will be ignored. If false, an error will be returned if there are IDs in the list which are not in the collection. mergeList=false is the behavior of the function without the mergeList parameter.