MetaInfo Class
The IMetaInfo interface contains the basic functions of the CMetaObject and CMetaRepository classes and additional enhanced properties.
|
Property |
Type |
Description |
|
Common Properties |
|
See “Common Properties”. |
|
PropertyItems |
IMetaPropertyItemList |
An interface to a list of property items of the object. |
|
DIMInfo |
IMetaDIMInfo |
An interface to the DIM information. |
|
PublishState |
MetaPublishState |
The publish-state of the object (mds_psCurrent, mds_psDeleted or mds_psInactive) Read only. |
|
VersionNumber |
long |
The version of the object. Read only. |
get_PropertyItems
Purpose:
Gets or sets the object properties list.
Syntax:
HRESULT get_PropertyItems(
[out, retval] IMetaPropertyItemList **pVal);
put_PropertyItems
Purpose:
Sets the object properties list.
Syntax:
HRESULT put_PropertyItems(
[in] IMetaPropertyItemList* newVal);
get_DIMInfo
Purpose:
Gets or sets a pointer to the DIMInfo object for this MetaInfo object.
Syntax:
HRESULT get_DIMInfo(
[out, retval] IMetaDIMInfo* *pVal);
put_DIMInfo
Purpose:
Sets the DIM attributes in the object.
Syntax:
HRESULT put_DIMInfo(
[in] IMetaDIMInfo* newVal);
get_PublishState
Purpose:
Returns the PublishState of the object. The MetaPublishState enumeration has four values: mds_psCurrent (2), which means this is the currently active or “published” version — it is the latest version and may be modified; mds_psInactive (1), which means this version is “frozen” and may not be modified (typically any version other than the “published” or “current” version); and mds_psDeleted (0), which means this version has been deleted but not removed from the repository; and mdsDormant (-1) which means the object is in the dormant state.
Syntax:
HRESULT get_PublishState(
[out, retval] MetaPublishState* state);
get_VersionNumber
Purpose:
Returns the version number of the object.
Syntax:
HRESULT get_VersionNumber(
[out, retval] long* version);
get_Frozen
Purpose:
This property returns the frozen state of the object. If an object is frozen it cannot be modified. The current or active version of the object can also be frozen in some cases. An object version that is inactive will always be frozen.
Syntax:
HRESULT get_Frozen(
[out, retval] VARIANT_BOOL* pVal);
GetObjectVersionKeys
Purpose:
Returns the versioned-key list for all versions of the object.
Syntax:
HRESULT GetObjectVersionKeys(
[out, retval] IMetaVersionedInfoKeyList** keyList);
GetObjectVersions
Purpose:
Returns all the versions of the object in the InfoList return parameter.
Description:
No DIM information will be returned with the objects so fields of the IMetaDIMInfo object returned by the DIMInfo property will all be empty. It is not necessary to "Read" the object before this call is made. You can use *any* object ID of the various versions of the object, as they will all return the same list of objects namely, those of all the versions.
Syntax:
HRESULT GetObjectVersions(
[out, retval] IMetaInfoList** InfoList);
FindLabel
Purpose:
This routine returns the key for the version of the object that has the specified label. If none of the versions of the object have the label, the status META_E_LABEL_NOT_USED will be returned.
Syntax:
HRESULT FindLabel(
[in] BSTR LabelName,
[out, retval] IMetaVersionedInfoKey** key);
GetObjectPropertyKeys
Purpose:
Returns a list of versioned-object keys that match the value of the property named in the IMetaPropertyItem interface object.
Description:
If the property value is a string, a substring search is performed; for all other types of property values, an equality search is made. The LabelName, if provided, is used as a filter on the keyList in that only those object versions that match the property value and have the label applied will be returned.
Requirements:
The IMetaPropertyItem's Name and Value must be set.
Syntax:
HRESULT GetObjectPropertyKeys(
[in] IMetaPropertyItem* propItem,
[in, optional] BSTR LabelName,
[out, retval] IMetaVersionedInfoKeyList** keyList);
GetObjectLabelKeys
Purpose:
Returns a list of the labels currently applied to the versions of the CMetaObject.
Description:
Each entry in the keyList vector is an IMetaLabeledInfoKey object, which will provide the name of a label and a key for the object version having that label. Only versions of the object that have a label applied will be in the key list.
Syntax:
HRESULT GetObjectLabelKeys(
[out, retval] IMetaLabelInfoKeyList** keyList);