FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kPxPort_EnableDrop ( kPxPort  port,
kBool  enable 
)

Enables an output port to drop messages.

By default, the DropEnabled property is set to kFALSE, meaning that messages cannot be dropped. If this property is set to true, the pipe can decide (at its discretion) to drop messages that are sent on this port. The most common use for this feature is to prevent the unbounded accumulation of asynchronously-generated messages within pipe message processing buffers.

This method can only be called from within a block's VOnSetup override.

Parameters
portPort object.
enablekTRUE to enable messages to be dropped by the pipe.
Returns
Operation status.
See also
kPxBlock_Send, kPxBlock_OnEngage