GetDormantDIMClassObjectKeys - Teradata Meta Data Services

GetDormantDIMClassObjectKeys

Purpose

GetDormantDIMClassObjectKeys returns a list of CMetaObjectKeys (contains object id and name only) that identify the dormant objects in the specified class. This API enables a meta data browser to display the name/id of objects in a class without having to read the entire collection of objects into memory. This is important for large collections which would consume a large amount of process space if all read into memory.

Requirements

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

The class ID (internal or globally unique) must be set.

Syntax

HRESULT GetDormantDIMClassObjectKeys(

MetaObjectKeyVector& objectKeyList,

const GUID& gClassID,

const OBJECTID_t lClassID = NULLLOID,

LPCTSTR strObjName = NULL,

const bool WithLock = false);

Argument	In/Out	Description
objectKeyList	In/Out	Linked list of CMetaObjectKeys. The list is cleared before adding the return collection.
gClassID	In	Class GUID.
IClassID	In	Class internal ID
StrObjName	In (Optional)	Search string for names of objects in the class to be returned.
WithLock	In	WithLock=true keeps the class table locked for WRITE. Use within an explicit transaction. Set WithLock to true when one of the class objects will subsequently be updated within the transaction. Prevents deadlocks caused by Teradata promotional locks.