SomCheckId: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:somCheckId}} | {{DISPLAYTITLE:somCheckId}} | ||
This function registers a som ID. | This function registers a som ID. | ||
==Syntax== | ==Syntax== | ||
somId id; | |||
somId id; | somId rc; | ||
somId rc; | |||
rc = somCheckId(id); | |||
==Parameters== | ==Parameters== | ||
; | ;id (somId): The somId to be registered. | ||
==Return Code== | ==Return Code== | ||
; | ;rc (somId) : The registered somId. | ||
==Remarks== | ==Remarks== | ||
This function registers a SOM ID and converts it into an internal representation. The input SOM ID is returned. If the ID is already registered, this function has no effect. | This function registers a SOM ID and converts it into an internal representation. The input SOM ID is returned. If the ID is already registered, this function has no effect. | ||
==Example Code== | ==Example Code== | ||
| Line 24: | Line 21: | ||
==Related== | ==Related== | ||
;Data Structures | |||
* somId (sombtype.h) | * somId (sombtype.h) | ||
;Methods | |||
* [[somRegisterId]] | * [[somRegisterId]] | ||
* [[somIdFromString]] | * [[somIdFromString]] | ||
| Line 38: | Line 34: | ||
* [[somEndPersistentIds]] | * [[somEndPersistentIds]] | ||
[[Category:SOM | [[Category:SOM function]] | ||
Latest revision as of 02:23, 6 May 2020
This function registers a som ID.
Syntax
somId id; somId rc; rc = somCheckId(id);
Parameters
- id (somId)
- The somId to be registered.
Return Code
- rc (somId)
- The registered somId.
Remarks
This function registers a SOM ID and converts it into an internal representation. The input SOM ID is returned. If the ID is already registered, this function has no effect.
Example Code
See function somBeginPersistentIds().
Related
- Data Structures
- somId (sombtype.h)
- Methods