RemoveFromOrigCollection - 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

RemoveFromOrigCollection

Purpose

The CMetaObject class RemoveFromOrigCollection function removes the specified object ID from the Origin collection.

Description

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

RemoveFromOrigCollection only removes the current version of the CMetaObject from the collection of lOrigID's current version. If necessary, RemoveFromOrigCollection will determine the current version for the CMetaObject and lOrigID.

Requirements

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

Syntax

HRESULT RemoveFromOrigCollection(
const OBJECTID_t lOrigID, 
const GUID &gRelID, 
const OBJECTID_t lRelID = NULLLOID);
 

Argument

In/Out

Description

lOrigID

In

ObjectID to remove from the origin 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.