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

CreateMDSClassDesc

Purpose

The CMetaAIM CreateMDSClassDesc function creates a new class description in the current model.

Description

The class can be used to create its associated property descriptions. It can also be used in new relationship description definitions.

The default OwnerID is the logged in user. The class's versioning support will be set from the AIM's versioning support.

Requirements

Updates to an existing Class Description object are not permitted.

Class names must be unique within an AIM.

Syntax

HRESULT CreateMDSClassDesc(
	CMetaClassDesc *&pClassObj,
	LPCTSTR strClassName,
	LPCTSTR strClassDesc,
	const short sUniqueNamesFlag,
	const GUID& gClassID,	
	const OBJECTID_t lOwnerID,
	const OBJECTID_t SecurityProfileID,
	const bool bRootClass);
 

Argument

In/Out

Description

pClassObj

In/Out

Pointer to Class Desc object. If pClassObj is a pointer to NULL, the object is created by the API. The calling application is responsible for freeing the object.

Name

In

Name of the class.

Desc

In

Description of class.

UniqueNamesFlag

In

MD_UNIQUE = maintain unique names (default)
MD_NULL = do not maintain unique names.

gClassID

In

Global unique identifier to assign to this class.

OwnerID

In

OwnerID of this object. The default OwnerID is the logged in user.

bRootClass

In

True = set this class to be a root class of the model. The MDS browsers begin tree displays of the data in the model at the root classes.

SecurityProfileID

in

Security Profile assigned to the object.