Jump to content

wpQueryObjectID

From EDM2

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

This instance method returns the unique, text object ID that was assigned to the given object when it was installed or changed (with wpSetup).

Syntax

_wpQueryObjectID(somSelf)

Parameters

somSelf (WPObject *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPObject.

Returns

pszObjectID (PSZ) - returns
String containing a unique object ID.
For example, "<WP_DESKTOP>".

How to Override

This method is generally not overridden.

Remarks

The install routine uses this variable to ensure that a given object is never re-installed, thereby avoiding duplication of objects. The object ID is always lost when the object is copied; therefore, only one object ever exists for a given object ID.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPObject *somSelf; /* Pointer to the object on which the method is being invoked. */
PSZ pszObjectID; /* String containing a unique object ID. */

pszObjectID = _wpQueryObjectID(somSelf);

Related Methods