GetDormantDIMDestObject - Teradata Meta Data Services

GetDormantDIMDestObject

Purpose

GetDormantDIMDestObject determines if a specific object is dormant or active. sObjName is the name of an object to search for in the destination class of the relationship.

Description

GetDormantDIMDestObject has three possible return scenarios:

A META_E_OBJECT_NOT_FOUND result indicates that the object does not exist, not even in dormant form; the returned CMetaObject will have null/default values.

A S_OK and IsPublished()=true result means that the object exists in an active state and the current object will be returned; this would be same as calling GetDestCollection().

A S_OK and IsDormant()=true result means that the object currently exists in a dormant form, and the object's previous properties will be returned.

Requirements

You must be initialized as an MDS Administrator (superuser) to use this function.

The calling object must be from the origin class of the relationship specified by relGuid or relLoid and the calling object must specify the loid or guid of a version of the object.

Syntax

HRESULT GetDormantDIMDestObject(

CMetaObject& returnObj,

LPCTSTR sObjName,

const GUID&	relGuid,

const OBJECTID_t relLoid = NULLLOID);

Argument	In/Out	Description
returnObj	In/Out	Object to contain the return object, if found
sObjName	In	Name of object to search for in the destination class; may not be NULL or empty
relGuid	In	Relationship GUID
relLoid	In	Relationship internal ID