getCatalogComment

First introduced in version: 3.00.6

Syntax

getCatalogComment(catalog)

Details

Returns the comment for the specified catalog.

Parameters

catalog is a STRING scalar specifying an existing catalog.

Returns

A STRING scalar.

Examples

catalogName = "securitiesMarketCatalog"
if (existsCatalog(catalog=catalogName)) {
    dropCatalog(catalog=catalogName)
}

createCatalog(catalog=catalogName)
setCatalogComment(catalog=catalogName, comment="Securities market data")

getCatalogComment(catalog=catalogName)
// output: Securities market data

Related functions: setCatalogComment