Equinox Online Help - Language Reference - A to Z
Catalogname |
|
|---|---|
| Applies to |     |
| Syntax | CatalogName ObjectType, ItemNumber, Name [, Upgrade] |
| Action | [Function] Once a catalog has been created (using LoadCatalogs) CatalogName can be used to extract the name of an item in the catalog. |
| Scope | Usable anywhere |
| Notes | ObjectType can take one of six parameters:
ItemNumber is an integer that refers to the number of the item you are retrieving the name for in the list of catalog items. Name will contain a string when the function is returned Upgrade is an optional parameter that takes the value 0 or 1.
|
| Category | Catalogs |
| See Also | CatalogEnumProperty, CatalogProperty, LoadCatalogs |
| Example | This example gets the item name based on the ObjectType and ItemNumber: CatalogName vnObjectType, vnItemNumber, vsName |