PtDestroySurfaceById()

Destroy the control surface with a given ID

Synopsis:

int PtDestroySurfaceById( PtWidget_t *widget,
                          unsigned char surface_id );

Library:

ph

Description:

This function destroys the control surface with ID surface_id belonging to the given widget.


Note: All surfaces of a widget are automatically destroyed when the widget is destroyed.

Returns:

0
Success.
-1
The specified surface couldn't be found.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PtCreateActionSurface(), PtCreateSurface(), PtDestroyAllSurfaces(), PtDestroySurface()

Control Surfaces chapter of the Photon Programmer's Guide