Jump to content

wpSetObjectListFromStrings

From EDM2
Revision as of 04:00, 25 November 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:wpSetObjectListFromStrings}} This method is specific to version 3, or higher, of the OS/2 operating system. This instance method adds a set of objects defined by a string list to the Toolbar or drawers. ==Syntax== _wpSetObjectListFromStrings(somSelf, ulDrawer, pszSetup, ulAfter) ==Parameters== ;''somSelf'' (WPLaunchPad *) - input :Pointer to the object on which the method is being invoked. :Points to an object of class...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This method is specific to version 3, or higher, of the OS/2 operating system.

This instance method adds a set of objects defined by a string list to the Toolbar or drawers.

Syntax

_wpSetObjectListFromStrings(somSelf,
                            ulDrawer, pszSetup, ulAfter)

Parameters

somSelf (WPLaunchPad *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPLaunchPad.
ulDrawer (ULONG) - input
Toolbar or drawers being set.
  • **0** Toolbar.
  • **>0** Drawer identifier.
pszSetup (PSZ) - input
Setup string that defines the list of object IDs or the path and file names of objects to be added.
Each entry in the list is terminated by a **NULL** character, and the last entry is terminated by two successive **NULL** characters.
ulAfter (ULONG) - input
Number of the object after which the new objects are inserted.
  • **ADD_OBJECT_FIRST** Adds the new objects to the top of the list.
  • **ADD_OBJECT_LAST** Adds the new objects to the bottom of the list.
  • **other** Adds the new objects after the object associated with the given index. For example, to insert after the first object, set *ulAfter* to 1.

Returns

rc (BOOL) - returns
Success indicator.
  • TRUE Successful completion.
  • FALSE Error occurred.

How to Override

This method can be overridden to know when objects are being added.

Usage

This method is not covered in the provided text.

Remarks

This method is not covered in the provided text.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPLaunchPad *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG ulDrawer; /* Toolbar or drawers being set. */
PSZ pszSetup; /* Setup string that defines the list of object IDs or the path and file names of objects to be added. */
ULONG ulAfter; /* Number of the object after which the new objects are inserted. */
BOOL rc; /* Success indicator. */

rc = _wpSetObjectListFromStrings(somSelf,
            ulDrawer, pszSetup, ulAfter);

Related Methods