SomGetMethodData: Difference between revisions
Created page with "{{DISPLAYTITLE:somGetMethodData}} This method returns method information for a specified method, which must have been introduced by the receiver class or an ancestor of that c..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:somGetMethodData}} | {{DISPLAYTITLE:somGetMethodData}} | ||
This method returns method information for a specified method, which must have been introduced by the receiver class or an ancestor of that class. Not generally overridden. | This method returns method information for a specified method, which must have been introduced by the receiver class or an ancestor of that class. Not generally overridden. | ||
; Original Class : [[SOMClass]] | ; Original Class : [[SOMClass]] | ||
| Line 8: | Line 8: | ||
==Parameters== | ==Parameters== | ||
; | ;receiver (SOMClass) : A pointer to the class that produced the index value. | ||
; methodId (somId) : A somId for the method's name. | ;methodId (somId) : A somId for the method's name. | ||
; md (somMethodData) : A pointer to a somMethodData structure. | ;md (somMethodData) : A pointer to a [[somMethodData]] structure. | ||
==Return Code== | ==Return Code== | ||
; rc (boolean) | ;rc (boolean) | ||
* true - Returns boolean true if successful. | |||
* false - Returns false if not successful. | |||
==Remarks== | ==Remarks== | ||
This method loads a somMethodData structure with data describing the method identified by the passed methodId. If methodId does not identify a method known to the receiver, then false is returned; otherwise, true is returned after loading the somMethodData structure with data corresponding to the indicated method. | This method loads a somMethodData structure with data describing the method identified by the passed methodId. If methodId does not identify a method known to the receiver, then false is returned; otherwise, true is returned after loading the somMethodData structure with data corresponding to the indicated method. | ||
| Line 32: | Line 32: | ||
SOM_Test(rc && somCompareIds(gmiId, md.id); | SOM_Test(rc && somCompareIds(gmiId, md.id); | ||
} | } | ||
</PRE> | </PRE> | ||
==Related== | ==Related== | ||
;Data Structures | |||
* somMethodData (somapi.h) | * somMethodData (somapi.h) | ||
;Methods | |||
* [[somGetMethodIndex]] | * [[somGetMethodIndex]] | ||
* [[somGetMethodData]] | * [[somGetMethodData]] | ||
Revision as of 15:42, 3 April 2025
This method returns method information for a specified method, which must have been introduced by the receiver class or an ancestor of that class. Not generally overridden.
- Original Class
- SOMClass
Syntax
boolean somGetMethodData (SOMClass receiver, somId methodId, somMethodData md)
Parameters
- receiver (SOMClass)
- A pointer to the class that produced the index value.
- methodId (somId)
- A somId for the method's name.
- md (somMethodData)
- A pointer to a somMethodData structure.
Return Code
- rc (boolean)
- true - Returns boolean true if successful.
- false - Returns false if not successful.
Remarks
This method loads a somMethodData structure with data describing the method identified by the passed methodId. If methodId does not identify a method known to the receiver, then false is returned; otherwise, true is returned after loading the somMethodData structure with data corresponding to the indicated method.
Example Code
#include <somcls.xh>
main
{
somEnvironmentNew();
somId gmiId = somIdFromString("somGetMethodIndex");
somMethodData md;
boolean rc = _SOMClass->somGetMethodData(gmiId, &md);
SOM_Test(rc && somCompareIds(gmiId, md.id);
}
Related
- Data Structures
- somMethodData (somapi.h)
- Methods