ApDeleteDBWidget()

Remove widgets from a widget database

Synopsis:

#include <Ap.h>

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

Arguments:

db

A pointer to a widget database that you opened with either ApOpenDBase() or ApOpenDBaseFile().

wgt_name

The instance name of the widget that you want to delete.

Library:

Ap

Description:

ApDeleteDBWidget() removes the widget named wgt_name from the widget database indicated by db. If the widget is a container, its children are also removed.

Returns:

0

Success.

-1

Failure.

Examples:

ApDBase_t *my_dbase;

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

ApDeleteDBWidget( my_dbase, "my_icon" );

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

Classification:

Photon

See also:

ApCopyDBWidget(), ApOpenDBase(), ApOpenDBaseFile(), ApSaveDBaseFile()

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