WinReplaceObjectClass: Difference between revisions

Latest revision as of 13:39, 5 December 2019

Replaces a registered class with the new registered class.

WinReplaceObjectClass(oldClassName, newClassName, functionReplacementFlag)

Flag values for functionality replacement:

This function returns a APIRET with the values of:

INCL_WINWORKPLACE

...
PSZ   oldClassname;
PSZ   newClassname;
BOOL  fReplace;
BOOL  rc;
...
rc = WinReplaceObjectClass (oldClassname, newClassname, fReplace);
...

The new class name must be a descendant of old class name. If it isn't, an error will be returned.

@@ Line 1: / Line 1: @@
-#REDIRECT [[OS2 API:PMI:WinReplaceObjectClass]]
+Replaces a registered class with the new registered class.
+===Syntax===
+ WinReplaceObjectClass(oldClassName, newClassName, functionReplacementFlag)
+=== Parameters ===
+; oldClassName - [[PSZ]] - input : Old classname string.
+; newClassName - [[PSZ]] - input : New classname string.
+; functionReplacementFlap -[[BOOL]] - input : Flag for function replacement.
+=== Constants ===
+Flag values for functionality replacement:
+;[[TRUE]] : Replace the old class name with the new class name.
+;[[FALSE]] : Undo the replacement of the old class name with the new class name.
+=== Returns ===
+This function returns a [[APIRET]] with the values of:
+*[[TRUE]]
+*[[FALSE]]
+=== Define (C/C++) ===
+INCL_WINWORKPLACE
+=== Calling Convention ===
+[[Cdecl32]]
+=== Example Code ===
+ ...
+ [[PSZ]]   oldClassname;
+ PSZ   newClassname;
+ [[BOOL]]  fReplace;
+ BOOL  rc;
+ ...
+ rc = WinReplaceObjectClass (oldClassname, newClassname, fReplace);
+ ...
+=== Related Functions ===
+*[[WinCreateObject]]
+*[[WinDeregisterObjectClass]]
+*[[WinRegisterObjectClass]]
+=== Notes ===
+The new class name must be a descendant of old class name.  If it isn't, an error will be returned.
+[[Category:Win]]