EnumUserMeasurements Method

EnumUserMeasurements Method (McEngine)

Description

Enumerates registered user measurements.

Return Type

A Long value.

[out, retval]

Syntax

object.EnumUserMeasurements (CookieNext, RegisteredName, RegisteredMcUserMeasureObject, RegisteredAllowedParent)

The EnumUserMeasurements Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McEngine.
CookieNext	Required. A Long value. Initialize this to zero to start the enumeration or to get the number of user measurements registered.
RegisteredName	Required. A String value. The next measurement name is placed in this variable.
RegisteredMcUserMeasureObject	Required. An Unknown object. The next measurement McUserMeasure object instance is placed in this variable.
RegisteredAllowedParent	Required. A mcMeasurementParentAllowed enumeration, as described in settings. THe next measurement's allowed parents enum is placed in this variable.

Settings

The settings for RegisteredAllowedParent are:

Constant		Value	Description
	mcmpaAnyParent	0	mcmpAnyParent or mcmpaAnyParent. any parent is allowed
	mcmpaChildOfEngine	1	an immediate child of McEngine
	mcmpaChildOfImages	2	an immediate child of McEngine.Images (note the plural)
	mcmpaChildOfImage	3	an immediate child of an McImage (note the singular)
	mcmpaChildOfLines	4	an immediate child of an McLines
	mcmpaChildOfPoints	5	an immediate child of an McPoints
	mcmpaChildOfRegions	6	an immediate child of an McRegions
	mcmpaChildOfFeatures	10	an immediate child of any McFeatures (an McPoints, McLines or McRegions)
	mcmpaChildOfRefFeatures	11	an immediate child of McRefFeatures
	mcmpaDescendentOfFeatures	12	an McFeatures descendent (descendended from an McPoints, McLines or McRegions)
	mcmpaDescendentOfImages	13	any McEngine.Images descendent
	mcmpaDescendentOfImage	14	any McImage descendent
	mcmpaNoParent	20	no parent (i.e., global)
	mcmpaOtherParent	21	some other parent type than ones listed