PtStartFlux()

Prevent repairs to a container widget and its children

Synopsis:

int PtStartFlux( PtWidget_t *container );

Library:

ph

Description:

This function increments the flux count for the given container, to prevent repairs to the specified container and to all its children. You can still modify the widgets, but the damage to them isn't recorded.

You typically use this function when you're about to make a lot of changes to the container and its children, and you don't want to update the display until you're done. When you want repairs to be made, call PtEndFlux().

Returns:

The container's new flux count, or -1 if an error occurred.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PtEndFlux(), PtIsFluxing()

“Delaying and forcing updates to the display” in the Working with Code chapter of the Photon Programmer's Guide