Jump to content

SomGetNthMethodData: Difference between revisions

From EDM2
Created page with "{{DISPLAYTITLE:somGetNthMethodData}} This method returns method information for the nth (static or dynamic) method known to a given class. Not generally overridden. For backw..."
 
Ak120 (talk | contribs)
mNo edit summary
 
Line 4: Line 4:
For backward compatibility, this method does not take an Environment parameter.
For backward compatibility, this method does not take an Environment parameter.


; Original Class : [[SOMClass]]
;Original Class: [[SOMClass]]
 
==Syntax==
==Syntax==
  boolean somGetNthMethodData (SOMClass receiver, long index, somMethodData md)
  boolean somGetNthMethodData (SOMClass receiver, long index, somMethodData md)


==Parameters==
==Parameters==
; receiver (SOMClass) : A pointer to the class that produced the index value.  
;receiver (SOMClass) : A pointer to the class that produced the index value.
 
;index (long) : An index returned as a result of a previous call of somGetMethodIndex.  
; index (long) : An index returned as a result of a previous call of somGetMethodIndex.  
;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.
* true       Returns boolean true if successful.  
* false - Returns false if not successful.
* false     Returns false if not successful.


==Remarks==
==Remarks==
Line 39: Line 37:


==Related==
==Related==
===Data Structures===
;Data Structures
* somMethodData (somapi.h)
* somMethodData (somapi.h)
 
;Methods
==Methods==
* [[somGetMethodIndex]]
* [[somGetMethodIndex]]
* [[somGetMethodData]]
* [[somGetMethodData]]

Latest revision as of 17:42, 5 April 2025

This method returns method information for the nth (static or dynamic) method known to a given class. Not generally overridden.

For backward compatibility, this method does not take an Environment parameter.

Original Class
SOMClass

Syntax

boolean somGetNthMethodData (SOMClass receiver, long index, somMethodData md)

Parameters

receiver (SOMClass)
A pointer to the class that produced the index value.
index (long)
An index returned as a result of a previous call of somGetMethodIndex.
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 index. The index must have been produced by a previous call to exactly the same receiver class; the same method will in general have different indexes in different classes. If the index does not identify a method known to this class, 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");
   long index = _SOMClass->somGetMethodIndex(gmiId);
   somMethodData md;
   boolean rc = _SOMClass->somGetNthMethodData(index,&md);
   SOM_Test(rc && somCompareIds(gmiId, md.id));
}

Related

Data Structures
  • somMethodData (somapi.h)
Methods