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

FindLabel

Purpose

The CMetaObject class FindLabel function returns the key for the first version of the object that has the specified label.

Description

If none of the versions of the object have the label, the status META_E_LABEL_NOT_USED will be returned, and the return key will specify a loid of NULLLOID and a version number of zero. If multiple versions of the object have the label, the status META_E_MULTIPLE_OBJECTS_FOUND will be returned and the return key will specify the first version using the label.

Requirements:

  • The object ID (local or global) or the name and class ID must specify a version of the object to be searched.
  • labelToFind may not be null and it must match a known label.
  • Syntax

    HRESULT FindLabel(
    const TCHAR *labelToFind,
    CMetaVersionedObjectKey& key);
     

    Argument

    In/Out

    Description

    labelToFind

    In

    The label name to be used in the search.

    Key

    Out

    Contains the key information for the version matching the search criteria.