RemoveFromDestCollection - Teradata Meta Data Services

Teradata Meta Data Services Programmer Guide

Product
Teradata Meta Data Services
Release Number
15.00
Language
English (United States)
Last Update
2018-09-28
Product Category
Teradata Tools and Utilities

RemoveFromDestCollection

Purpose

The CMetaObject class RemoveFromDestCollection function removes the specified object 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). RemoveFromDestCollection only removes the current version of the destination object from the collection of the current version of the CMetaObject. If necessary, RemoveFromDestCollection will determine the current version for the CMetaObject and lDestID.

Requirements

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

Syntax

HRESULT RemoveFromDestCollection(
const OBJECTID_t lDestID, 
const GUID &gRelID, 
const OBJECTID_t lRelID = NULLLOID);
 

Argument

In/Out

Description

lDestID

In

ObjectID 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.