LibraryDelete

Description

Deletes a library file or, if you specify a DataWindow object, deletes the DataWindow object from the library.

Syntax

LibraryDelete ( libraryname {, objectname, objecttype } )

Argument

Description

libraryname

A string whose value is the name of the PowerBuilder library you want to delete or from which you want to delete a DataWindow object. If you do not specify a full path, LibraryDelete uses the system's standard file search order to find the file.

objectname (optional)

A string whose value is the name of the DataWindow object you want to delete from libraryname.

objecttype (optional)

A value of the LibImportType enumerated datatype identifying the type of object you want to delete. The only supported object type is ImportDataWindow!.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, LibraryDelete returns null.

Usage

You can delete DataWindow objects from a library in a script with the LibraryDelete function. To delete other types of objects, use the Library painter.

Examples

This statement deletes a library called dwTemp in the current directory and on the current application library path:

LibraryDelete("dwTemp.pbl")

See also

LibraryCreate

LibraryDirectory

LibraryExport

LibraryImport