company logo

IndexManager :: OpenInstance - Set instance to be indexed

In order to index a single instance, you must pass a property handle with a selected instance to the index manager. After setting an instance, the index manager will index only the selected instance in the property handle when calling Run();

A handle copy is created for the passed property handle, i.e. the index manager can be called again after changing the property handle selection in the calling program.

  IndexManager        im(...);

  

  im.SetInstance(object_ph);

  while ( object_ph.Get(index++) )

    im.Run("IndexOptions");

Return value:  Success ( logical  )

Implementation details

logical IndexManager  :: OpenInstance ( PropertyHandle *prophdl, NString &section_name )

In order to index a single instance, you must pass a property handle with a selected instance to the index manager. After setting an instance, the index manager will index only the selected instance in the property handle when calling Run();

The index manager can be called again after changing the property handle selection in the calling program.

  • prophdl - Pointer to roperty handle
  • section_name - - internal feature (not documented)