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

ReadDormantDIMObject

Purpose

ReadDormantDIMObject extends the functionality of ReadObject to support the Retain Associated Business Information feature. ReadDormantDIMObject returns an object that is either active or dormant. The requirements for specifying the object to be returned are the same as for ReadObject.

If the return status is S_OK, the caller should call IsDormant() to determine if the object exists or is dormant.

Requirements

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

The class ID (internal or globally unique) and object name or the object ID (internal or globally unique) must be set before calling ReadDormantDIMObject. If given, the internal object ID must be for a version of the object.

Syntax

HRESULT ReadDormantDIMObject();