LibraryDirectoryEx

Description

Obtains a list of the objects in a PowerBuilder library. The information provided is the object name, the date and time it was last modified, any comments for the object, and the object's type. You can get a list of all objects or just objects of a specified type.

Syntax

LibraryDirectoryEx ( libraryname, objecttype )

Argument

Description

libraryname

A string whose value is the name of the PowerBuilder library for which you want the contents. If you do not specify a full path, LibraryDirectory uses the operating system's standard file search order to find the file.

objecttype

A value of the LibDirType enumerated datatype identifying the type of objects you want listed:

  • DirAll! -- All objects

  • DirApplication! -- Application objects

  • DirDataWindow! -- DataWindow objects

  • DirFunction! -- Function objects

  • DirMenu! -- Menu objects

  • DirPipeline! -- Pipeline objects

  • DirProject! -- Project objects

  • DirQuery! -- Query objects

  • DirStructure! -- Structure objects

  • DirUserObject! -- User objects

  • DirWindow! -- Window objects


Return value

String.

LibraryDirectoryEx returns a tab-separated list with one object per line. The format of the list is:

name ~t date/time modified ~t comments ~t   type~n

Returns the empty string ("") if an error occurs. If any argument's value is null, LibraryDirectoryEx returns null.

Usage

If you call LibraryDirectoryEx with a PBD file as the first argument, no comments are displayed because they are not included in PBD files.

You can display the result of LibraryDirectoryEx in a DataWindow control by passing the returned string to the ImportString function for that DataWindow. The DataWindow should contain four string columns. The columns must be wide enough to fit the data in the input string. If not, PowerBuilder reports validation errors.

If you do not need to return the object's type, you can use LibraryDirectory.

For an example of parsing tab-delimited data, see the Pos or LastPos function.

Examples

This code imports the string returned by LibraryDirectoryEx to the DataWindow dw_list and then redraws the dw_list. The DataWindow was defined with an external source and four string columns:

String ls_entries
 
ls_entries = LibraryDirectoryEx( &
 "c:\pb\dwTemp.pbl", DirUserObject!)
dw_list.SetRedraw(FALSE)
dw_list.Reset( )
dw_list.ImportString(ls_Entries)
dw_list.SetRedraw(TRUE)

See also

ImportString

LibraryCreate

LibraryDelete

LibraryDirectory

LibraryExport

LibraryImport