SomTotalRegIds: Difference between revisions
Created page with "This function returns the total number of SOM IDs that have been registered. ==Syntax== <PRE> unsigned long rc; rc = somTotalRegIds(); </PRE> ==Parameters== ==Return Co..." |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:somTotalRegIds}} | |||
This function returns the total number of SOM IDs that have been registered. | This function returns the total number of SOM IDs that have been registered. | ||
==Syntax== | ==Syntax== | ||
unsigned long rc; | |||
unsigned long rc; | |||
rc = somTotalRegIds(); | |||
rc = somTotalRegIds(); | |||
==Parameters== | ==Parameters== | ||
==Return Code== | ==Return Code== | ||
; rc (unsigned long) : Returns the total number of SOM IDs that have been registered. | ;rc (unsigned long): Returns the total number of SOM IDs that have been registered. | ||
==Remarks== | ==Remarks== | ||
This function returns the total number of SOM IDs that have been registered so far. This value can be used as a parameter to the | This function returns the total number of SOM IDs that have been registered so far. This value can be used as a parameter to the somSetExpectedIds function to advise SOM about expected ID usage in later executions of a client program. | ||
somSetExpectedIds function to advise SOM about expected ID usage in later executions of a client program. | |||
==Example Code== | ==Example Code== | ||
| Line 32: | Line 30: | ||
==Related== | ==Related== | ||
;Functions | |||
* [[somCheckId]] | *[[somCheckId]] | ||
* [[somRegisterId]] | *[[somRegisterId]] | ||
* [[somIdFromString]] | *[[somIdFromString]] | ||
* [[somStringFromId]] | *[[somStringFromId]] | ||
* [[somCompareIds]] | *[[somCompareIds]] | ||
* [[somSetExpectedIds]] | *[[somSetExpectedIds]] | ||
* [[somUniqueKey]] | *[[somUniqueKey]] | ||
* [[somBeginPersistentIds]] | *[[somBeginPersistentIds]] | ||
* [[somEndPersistentIds]] | *[[somEndPersistentIds]] | ||
[[Category:SOM | [[Category:SOM function]] | ||
Latest revision as of 04:43, 6 May 2020
This function returns the total number of SOM IDs that have been registered.
Syntax
unsigned long rc; rc = somTotalRegIds();
Parameters
Return Code
- rc (unsigned long)
- Returns the total number of SOM IDs that have been registered.
Remarks
This function returns the total number of SOM IDs that have been registered so far. This value can be used as a parameter to the somSetExpectedIds function to advise SOM about expected ID usage in later executions of a client program.
Example Code
#include <som.h>
main()
{ int i;
somId id;
somEnvironmentNew();
id = somIdFromString("abc")
i = somTotalRegIds();
id = somIdFromString("abc");
SOM_Test(i == somTotalRegIds);
}
Related
- Functions