SomSetExpectedIds: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:somSetExpectedIds}} | {{DISPLAYTITLE:somSetExpectedIds}} | ||
This function tells SOM how many unique SOM IDs a client program expects to use. | This function tells SOM how many unique SOM IDs a client program expects to use. | ||
==Syntax== | ==Syntax== | ||
unsigned long numIds; | |||
unsigned long numIds; | |||
somSetExpectedIds(numIds); | |||
somSetExpectedIds(numIds); | |||
==Parameters== | ==Parameters== | ||
; numIds (unsigned long) : The number of SOM IDs the client program expects to use. | ;numIds (unsigned long): The number of SOM IDs the client program expects to use. | ||
==Return Code== | ==Return Code== | ||
| Line 17: | Line 16: | ||
==Example Code== | ==Example Code== | ||
#include <som.h> | |||
#include <som.h> | somSetExpectedIds(1000); | ||
somSetExpectedIds(1000); | |||
==Related== | ==Related== | ||
;Functions | |||
* [[somCheckId]] | * [[somCheckId]] | ||
* [[somRegisterId]] | * [[somRegisterId]] | ||
* [[somIdFromString]] | * [[somIdFromString]] | ||
* [[somStringFromId]] | * [[somStringFromId]] | ||
* [[somCompareIds]] | * [[somCompareIds]] | ||
* [[somTotalRegIds]] | * [[somTotalRegIds]] | ||
* [[somUniqueKey]] | * [[somUniqueKey]] | ||
* [[somBeginPersistentIds]] | * [[somBeginPersistentIds]] | ||
* [[somEndPersistentIds]] | * [[somEndPersistentIds]] | ||
[[Category:SOM | [[Category:SOM function]] | ||
Latest revision as of 05:10, 6 May 2020
This function tells SOM how many unique SOM IDs a client program expects to use.
Syntax
unsigned long numIds; somSetExpectedIds(numIds);
Parameters
- numIds (unsigned long)
- The number of SOM IDs the client program expects to use.
Return Code
Remarks
This function informs the SOM run-time environment how many unique SOM IDs a client program expects to use during its execution. This has the potential of slightly improving the program's space and time efficiency, if the value specified is accurate. This function, if used, must be called prior to any explicit or implicit invocation of the somEnvironmentNew function to have any effect.
Example Code
#include <som.h> somSetExpectedIds(1000);
Related
- Functions