ChoiceSink Object

Provides a mechanism for subscribing to a single Choice object.

Syntax

ChoiceSink

Remarks

• Typically, a DTC object subscribes to Choice objects by calling the AddChoiceSink method to add a ChoiceSink object to the ChoiceSinks collection. The Choice sink contains a ChoiceFilter object that specifies which Choice objects are relevant.
  
  
• When the Choices engine finds a Choice object that matches the Choice filter in the Choice sink, it does the following:
  • Updates the BoundChoice property of the ChoiceSink with the pointer to the Choice object that matched.
    
    
  • Calls the DTC's OnChoiceChange method and passes the relevant ChoiceSink.

  Note   Only one Choice object is recognized for each ChoiceSink. If multiple choices match, only the first is reported. To find the set of available choices, examine the Choices collection passed to the OnRebind method.

When a Choice sink is no longer needed, you can use the DeleteChoiceSink method on the ChoiceSinks collection to delete it.

Note   You rarely need to call this method directly because the Choices engine automatically calls DeleteChoiceSink when it detects that a DTC object has been deleted.

See also   Subscribing to a Choice