IMcObjectsGetCategoryCount Method
|
|
Returns a count of all McObjects in one category
with some particular (or no) parent object, as filtered by SetEnumFilters.
Namespace:
MediaCy.IQL.ObjectManager
Assembly:
MediaCy.IQL.ObjectManager (in MediaCy.IQL.ObjectManager.dll) Version: 10.0.6912.0
SyntaxFunction GetCategoryCount (
varCategoryNameOrID As Object,
<OptionalAttribute> varParentIMcObject As Object,
Optional eControlFlags As mcobjEnumFiltersFlags = mcobjEnumFiltersFlags.mcobjEnumDefault
) As Integer
Parameters
- varCategoryNameOrID
- Type: SystemObject
[in] Category name or ID (as returned from
RegisterCategory). - varParentIMcObject (Optional)
- Type: SystemObject
[in, optional] Parent object for the
collection, or missing (VT_EMPTY or VT_ERROR) for global objects. - eControlFlags (Optional)
- Type: MediaCy.IQL.ObjectManagermcobjEnumFiltersFlags
[in, defaultvalue(mcobjEnumDefault)]
Return Value
Type:
Int32Count of all McObjects in the collection.
RemarksThe count takes into account any filters which have been set by the
SetEnumFilters method. You may use the mcobjEnumResetToNoFilter eControlFlags
bit to ensure that no previous SetEnumFilters call will disturb an enumeration.
Note that the enumeration filters are also automatically cleared by any call to
GetCategory_NewEnum or they can be cleared with a call to SetEnumFilters with
the eControlFlags set to mcobjEnumResetToNoFilter.
By default only objects that were created by this instance of McObjects
will be included in the count. Set the mcobjEnumAllCreators flag in the
eControlFlags argument or make a prior call to SetEnumFilters with
this flag set to override this behavior.
By default only normal, non-alias objects are enumerated. Set either
the mcobjEnumAliasOrShadow or mcobjEnumAliasOnly flags in the
eControlFlags argument or make a prior call to SetEnumFilters with
one of these flags set to override this behavior.
If the SetEnumFilters method has been called, then the mcobjEnumDataNotObject,
mcobjEnumAllCreators, mcobjEnumAliasOrShadow, or mcobjEnumAliasOnly flags could
be set by either it's eControlFlags argument or with this method's eControlFlags
argument; however the mcobjEnumAllParents always comes from the SetEnumFilters
call (see Notes).
If SetEnumFilters has been called before this call, then the SetEnumFilters
varParentIMcObject argument and mcobjEnumAllParents eControlFlags bit control
the parent test; the corresponding arguments here are ignored. Thus, if SetEnumFilters
is used you must supply the proper varParentIMcObject argument (and any
mcobjEnumAllParents eControlFlags bit) there.
See AlsoReference
IMcObjects.get_Count