[Previous] [Contents] [Index] [Next]

PtContainerRelease()

Decrement the hold count for a widget

Synopsis:

int PtContainerRelease( PtWidget_t *container_widget );

Description:

This function decrements the hold count for the specified container widget. The count was incremented by a previous call to PtContainerHold(). When the count reaches 0, the widgets are repaired.

When the widgets are eventually released, they aren't repaired separately. Instead, only the container parent widget is repaired. As a result, the children are all repaired simultaneously.


Note: PtContainerHold() and PtContainerRelease() increment/decrement a hold count for the specified container widget. This count is different from the global hold count, which is used by PtHold() and PtRelease() to hold all widgets.

Returns:

The container widget's current hold count.

Examples:

See PtClearWidget().

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PtContainerHold(), PtHold(), PtFlush(), PtRelease()


[Previous] [Contents] [Index] [Next]