ApDeleteWidget()

Remove widgets from a widget database

Synopsis:

#include <Ap.h>

int ApDeleteWidget( ApDBase_t *db,
                    char const *wgt_name );

Description:

ApDeleteDBWidget() removes the widget named wgt_name from the widget database indicated by db. Only a single widget is deleted with this function; if a container widget is deleted, its child widgets remain in the database.

Returns:

0

Successful completion

-1

Failure

Examples:

ApDBase_t *my_dbase;

my_dbase = ApOpenDBaseFile( "/home/me/mydbase.wgtp" );

ApDeleteWidget( my_dbase, "my_icon" );

ApSaveDBaseFile( my_dbase, "/home/me/mydbase.wgtp" );

Classification:

Photon

See also:

ApCopyWidget(), ApOpenDBase(), ApOpenDBaseFile(), ApSaveDBaseFile()

Accessing PhAB Modules from Code chapter of the Photon Programmer's Guide