Equinox Online Help - Language Reference - A to Z
CatalogEnumProperty |
|
|---|---|
| Applies to |     |
| Syntax | CatalogEnumProperty ObjectType, Name, PropertyNumber, PropertyName, PropertyValue [, Upgrade] |
| Action | [Function] This function will look up the property of an object, dependent on its name and ObjectType and property number and return the name of the property and its value |
| Scope | Usable anywhere. |
| Notes | This function is useful if you need to generate a list of properties for an object when the property numbers, names and values are not known. There is an optional parameter [,Upgrade] that specifies which catalog the function should use. The default is to use the application catalog. If this parameter takes the value 1 the function will try to use the [applicationName].pub file from the root folder of the application file. If this file does not exist, nothing will be returned. If a property is requested for a field and ultimately that property is not relevant to that field type, a default value of "invalid" is set within the Property Value when the function returns. Syserror is NOT set. However, if a property is requested that does not exist for any field type, then Syserror will be set to 1. ObjectType takes a numeric value of:
Name takes a string value and is a the name of the item you are looking to find the property for. PropertyNumber is an integer used to specify the starting point of the list you wish to increment through. This will usually be 1. If this number is out of range, a syserror will occur. PropertyName is a string. Its value is returned by the function, which corresponds to the name of the property specified in the propertyNumber parameter. PropertyValue is a string whose value is returned and which relates to the behaviour for the property you are returning. For example the size of a field or having 'line wrap' switched on or off (0 or 1). |
| Category | Catalogs |
| See Also | Catalogname, CatalogProperty, LoadCatalogs |
| Example | This example gets the PropertyName and PropertyValue based on the ObjectType, ItemNumber and PropertyNumber CatalogEnumProperty vnObjectType, vsName, vnPropertyNumber, vsPropertyName, vsPropertyValue |