PtSurfaceRemoveData(), PtSurfaceRemoveDataById()

Remove data from a control surface

Synopsis:

int PtSurfaceRemoveData( PtWidget_t *widget,
                         PtSurface_t *surface );

int PtSurfaceRemoveDataById( PtWidget_t *widget,
                             uchar_t surface_id );

Library:

ph

Description:

These functions remove user data from a control surface belonging to the given widget. They differ in the way they identify the control surface:

PtSurfaceRemoveData()

Uses the surface argument, which points to a PtSurface_t structure that describes the control surface. This pointer must not be NULL.

PtSurfaceRemoveDataById()

Searches the control surfaces belonging to the widget for the one with an ID of surface_id.

If, when the data was added, the len argument was nonzero, the copy of the data that was made is automatically freed, otherwise no deallocation takes place.

Data is automatically removed when a control surface is destroyed.

Returns:

-1

The control surface or data wasn't found.

Pt_CONTINUE

The data was found and released.

Pt_HALT

The data was found, the node was released, and the data was taken care of by the remove function.

Pt_END

The node wasn't removed; refused by the remove function.

Classification:

Photon

See also:

PtSurfaceAddData(), PtSurfaceAddDataById(), PtSurfaceGetData(), PtSurfaceGetDataById()

Control Surfaces chapter of the Photon Programmer's Guide