GetClassObjectVersionKeys
Purpose
GetClassObjectVersionKeys returns a list of CMetaVersionedObjectKeys (object id, name, version number, and publish state) which identify all of the versions of objects in the specified class.
Description
The GetClassObjectVersionKeys function is expected to be used by an application to enable it to display the name or ID of objects in a class without having to read the entire collection of objects into memory. This is important for large classes which would consume a large amount of process space if all the objects are read into memory.
Requirements
The internally unique or globally unique class ID must be specified.
Syntax
HRESULT GetClassObjectVersionKeys(
vector<CMetaVersionedObjectKey> &objectKeyList,
const GUID &gClassID,
const OBJECTID_t lClassID,
LPCTSTR strObjName = NULL,
LPCTSTR strLabel = NULL,
const bool WithLock = false);
|
Argument |
In/Out |
Description |
|
objectKeyList |
In/Out |
Reference to the list of CMetaVersionedObjectKeys that will hold the object keys returned. The list is cleared before adding the return collection. |
|
gClassID |
In |
Global unique Class ID. Can be set to NULLGUID if lClassID is set. |
|
lClassID |
In |
Internal Class ID. Optional if gClassID is set. |
|
strObjName |
In |
Specific name of object in the collection to be returned. |
|
strLabel |
In |
Label to be used as a filter on the returned objects; only versions with the label are returned |
|
WithLock |
In |
WithLock=true keeps the IClassID 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. This prevents deadlocks caused by Teradata promotional locks. |