WPTools Functions

WPToolsLoadFuncs
Make the functions in WPTools.DLL available to REXX.

Usage
/* First declare WPToolsLoadFuncs itself to REXX */ call RxFuncAdd 'WPToolsLoadFuncs', 'WPTOOLS', 'WPToolsLoadFuncs' /* Call WPToolsLoadFuncs itself. */ call WPToolsLoadFuncs

WPToolsQueryObject
Query object data

Usage
rc=WPToolsQueryObject(object, [Class], [Title], [Setup], [Location])


 * object : A fully qualified path name to a file or directory, or An OBJECTID string (e.g. ), or A string starting with a '#' and being followed by a hexadecimal object handle (See WPToolsFolderContent)
 * Class : The name of a REXX variable, enclosed in quotes, that will be created by WPTOOLS and will contain the class name of the object. This argument is optional.
 * Title : The name of a REXX variable, enclosed in quotes, that will be created by WPTOOLS and will contain the title of the object. This argument is optional.
 * Setup : The name of a REXX variable, enclosed in quotes, that will be created by WPTOOLS and will contain the setup string of the object. This argument is optional.
 * Location : The name of a REXX variable, enclosed in quotes, that will be created by WPTOOLS and will contain the location of the object. This argument is optional.

Returns: 1 on success and 0 when a error occurred.

Please note that only the object argument is mandatory. All other arguments only need to be present when the result is needed. Should you not need one argument, but need a argument that is after the not needed one, make sure you enter all comma's. (e.g.: rc = WPToolsQueryObject(object,,,"SetupString")

See Appendix I and II for information about objects and the setup values this call returns.

Example
 /* REXX must start with a comment line */

call RxFuncAdd 'WPToolsLoadFuncs', 'WPTOOLS', 'WPToolsLoadFuncs' call WPToolsLoadFuncs

iRetco = WPToolsQueryObject("", "szClass", "szTitle", "szSetupString", "szLocation") if Iretco Then do    say 'Class name :' szclass say 'Title     :' sztitle say 'Location  :' szlocation say 'Setupstring:' szsetupstring end else say 'Unable to return object settings for ' 

WPToolsFolderContent
Query abstract (non-disk) objects in a specific folder

Usage
rc=WPToolsFolderContent(folder, stem [,'F'])


 * folder : A fully qualified path name to a directory, or an OBJECTID string for a folder (e.g. 
 * stem : The name of a REXX stem variable that, on successful return, will contain all abstract objects present in a specific folder. Each returned entry will either be an OBJECTID (when an OBJECTID has been set for the returned object) or a string starting with a '#' and followed by the hexadecimal object handle.
 * 'F' : If specified, WPToolsFolderContent will return all filesystem objects as well.

Returns: 1 on success and 0 when a error occurred.

Example
/* REXX must start with a comment line */

call RxFuncAdd 'WPToolsLoadFuncs', 'WPTOOLS', 'WPToolsLoadFuncs' call WPToolsLoadFuncs

iRetco = WPToolsFolderContent("", "list.") if iRetco = 0 Then Do  exit End

say 'Abstract objects on :' do iObject = 1 to list.0 Iretco=WPToolsQueryObject(list.Iobject, "szclass", "sztitle", "szsetupstring", "szlocation") if Iretco Then do    say '"'szClass'", "'szTitle'", "'szSetupString'", "'szLocation'"' end end

WPToolsSetObjectData
Change the settings of an existing object. This functions works with object IDs, file names and object handles.

Usage
rc=WPToolsSetObjectData(object, setup)


 * object : A fully qualified path name to a file or directory, or an OBJECTID string (e.g. ), or a string starting with a '#' and being followed by a hexadecimal object handle (See WPToolsFolderContent)
 * setup : A WinCreateObject setup string

Returns: 1 on success and 0 when a error occurred.

NOTE: This function is equal to SysSetObjectData with one difference that beside a file name or OBJECTID also a '#' followed by an hexadecimal object handle can be specified. This makes it posible that the outcome if WPToolsFolderContent can be used.

WPToolsVersion
Query version of WPTOOLS.DLL.

Usage
version=WPToolsVersion

Example
 /* REXX must start with a comment line */

call RxFuncAdd 'WPToolsLoadFuncs', 'WPTOOLS', 'WPToolsLoadFuncs' call WPToolsLoadFuncs

Version = WPToolsVersion say 'WPTOOLS.DLL is of version' version 

Appendix I
The workplace shell class tree: Classes_Hierarchy

Appendix II
WPToolsQueryObject has code to support (almost) all object classes for which object setup strings are defined, being:
 * (1) Along with all settings for WPPrint.
 * (2) These settings cannot be used to recreate the object.
 * (3) MENU doesn't work when applying.

For each object, WPToolsQueryObject returns setup string values not only for the object itself (when supported) but also for all parent classes. When, for example, one uses WPToolsQueryObject against the Desktop (class WPDesktop) setup strings will be returned from the classes WPFolder, WPFileSystem and WPObject.

I did not build any support for WPSchemePalette because the setup string for this class do not support settings the colors on an individual basis but instead one should specify a color scheme name that is already present in the INI files.