MetaBIZInfo Class - 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

MetaBIZInfo Class

The MetaBIZInfo class is a non-creatable class that is returned only by the Item and Next calls from a MetaBIZInfoList collection object. If the search criteria matched multiple fields, all those that matched are returned.

get_ClassID

Purpose:

This is a read-only property that returns the class ID of the object.

Syntax:

HRESULT get_ClassID(
[out, retval] long *pVal);

get_ObjectID

Purpose:

This is a read-only property that returns the ID of the object.

Syntax:

HRESULT get_ObjectID(
[out, retval] long *pVal);

get_Name

Purpose:

This is a read-only property that returns the name of the object. The name of the object is always returned even if it did not match the search criteria, that is, even if the object is in the collection due to a match on the object's Description, Definition or Notes. (Note though, the name itself may be blank.).

Syntax:

HRESULT get_Name(
[out, retval] BSTR *pVal);

get_NameMatch

Purpose:

This is a read-only property that returns VARIANT_TRUE if this object is in the collection due to a match on its name. If the item is in the list due to a match on the Description, Definition or Notes instead, this is VARIANT_FALSE. (VARIANT_TRUE and VARIANT_FALSE are just True and False in Visual Basic.)

Syntax:

HRESULT get_NameMatch(
[out, retval] VARIANT_BOOL *pVal);

get_Description

Purpose:

This is a read-only property that returns the business description for this object.

Syntax:

 HRESULT get_Description(
[out, retval] BSTR *pVal);

get_Definition

Purpose:

This is a read-only property that returns the business definition for this object.

Syntax:

HRESULT get_Definition(
[out, retval] BSTR *pVal);

get_Notes

Purpose:

This is a read-only property that returns the business notes for this object.

Syntax:

HRESULT get_Notes(
[out, retval] BSTR *pVal);

get_VersionNumber

Purpose:

This is a read-only property that returns the object's version number.

Syntax:

get_VersionNumber(
long *pVal);

get_PublishState

Purpose:

This is a read-only property that returns the object version's publish state. The publish state is an enumeration of mdsCurrent, mdsInactive, mdsDeleted (currently not used) and mdsDormant.

Syntax:

HRESULT get_PublishState (
MetaPublishState *pVal);

get_Frozen

Purpose:

This is a read-only property that returns the object version's frozen property.

Syntax:

HRESULT get_Frozen (
VARIANT_BOOL *pVal);