ISCModelObject::CollectProperties Arguments

API Interfaces Reference › API Interfaces › ISCModelObject › ISCModelObject::CollectProperties Arguments

ISCModelObject::CollectProperties Arguments

Here is the signature for the CollectProperties function:

ISCModelPropertyCollection * CollectProperties(VARIANT ClassIds, VARIANT MustBeOn, VARIANT MustBeOff)

The following table contains the valid arguments for the CollectProperties function:

Parameter	Valid Type/Value	Description
ClassIds [optional]	Empty	All properties of the object are returned.
ClassIds [optional]	VT_ARRAY\|VT_BSTR – SAFEARRAY of property IDs	Provides a list of property class identifiers.
ClassIds [optional]	VT_ARRAY\|VT_BSTR – SAFEARRAY of property names	Provides a list of property class names.
ClassIds [optional]	VT_BSTR – ID of a property	Identifies a property class.
ClassIds [optional]	VT_BSTR – Name of a property	Identifies a property class.
ClassIds [optional]	VT_BSTR – List of IDs delimited by semicolons	Provides a list of property class identifiers.
ClassIds [optional]	VT_BSTR – List of property names delimited by semicolons	Provides a list of property class names.
MustBeOn [optional]	Empty	Defaults to SCD_MPF_DONT_CARE which indicates no filtering.
MustBeOn [optional]	VT_I4 – SC_ModelObjectFlags flags that must be on	Identifies the properties with the specified flags set.
MustBeOff [optional]	Empty	Defaults to SCD_MPF_DONT_CARE which indicates no filtering
MustBeOff [optional]	VT_I4 – SC_ModelObjectFlags flags that must be off	Identifies the properties that do not have the specified flags.

Note: For information about valid property class identifiers and valid property class names, see the HTML document ERwin Metamodel Reference, in the Metamodel Reference Bookshelf located in the CA ERwin Data Modeler installation folder. More information about SC_ModelObjectFlags is located in the Enumerations section.