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

SetDescriptionRequired

Purpose

SetDescriptionRequired is used to change the current setting of the class property indicating if a class object must have a non-null Description property. The change will not be effective until WriteObject is called.

The class loid must be greater than 10000.

If bRequired is true the class may not be in the reserved metamodels: DIM, CLM, MDSBase and CWM.

If bRequired is true and one or more existing objects in the class do not currently have a description, the error META_E_MISSING_REQUIRED_DESCRIPTION will be returned by WriteObject

Syntax

HRESULT SetDescriptionRequired(const bool bRequired);
 

Argument

In/Out

Description

bRequired

In

True = class objects must have non-null Description property

False = class objects do not require a Description property