Developer

NextCollectionProperty

This method returns the next member of the collection property referenced in the collection parameter. The method also updates the position pointer within the collection parameter to point to the next member of the collection property. The returned member is referenced in the property parameter to this method. If there is no next member, the type for this property is set to AXPT_Invalid. This can be checked using the GetPropertyType method, passing the property parameter to it.

The GetMappedProperty method should be called prior to this method. When the property returned in the property parameter is a collection, NextCollectionProperty is called to retrieve the members of that collection. When these members are object instances, the GetPropertyFromObject method is called subsequent to NextCollectionProperty to retrieve the property values found within the object instance.

Prototype

BOOL NextCollectionProperty (VARIANT* collection, VARIANT* property)

Parameters

  • collection - This parameter is the reference to the property returned by the GetMappedProperty method when the property it returns is a collection.
  • property - The next member of the collection property referenced by collection. This property type should always be checked with the GetPropertyType method before attempting to reference it to ensure it is not set to AXPT_Invalid. This type is returned when there is no next member in the collection.

Return Value

Boolean value indicating whether the position pointer references a valid collection member, or the end of the collection:
  • true - Returned if the position pointer of the collection parameter points to a valid member of the collection.
  • false - Returned if the position pointer of the collection parameter indicates the end of the collection has been reached.