SomRegisterId: Difference between revisions

Latest revision as of 02:36, 6 May 2020

This function registers a SOM ID and determines whether or not it was previously registered.

Syntax

somId    id;
int      rc;

rc = somRegisterId(id);

Parameters

id (somId)

Return Code

rc (int): Returns 0 if the ID is already registered.; Returns 1 if the ID is not already registered.

Remarks

This function registers a SOM ID and converts it into an internal representation. If the ID is already registered, this function returns 0 and has no effect. Otherwise, this function returns 1.

Example Code

#include <som.h>
static string s = "unregistered";
static somId sid = &s;
main()
{
   somEnvironmentNew();
   SOM_Test(somRegisterId(sid) == 1);
   SOM_Test(somRegisterId(somIdFromString("registered")) == 0);
}

@@ Line 14: / Line 14: @@
 ==Return Code==
-; rc (int) :
+; rc (int):
+:Returns 0 if the ID is already registered.
-   Returns 0 if the ID is already registered.
+:Returns 1 if the ID is not already registered.
-   Returns 1 if the ID is not already registered
 ==Remarks==
@@ Line 36: / Line 35: @@
 ==Related==
-===Data Structures===
+;Data Structures
-* somId (sombtype.h).
+* somId (sombtype.h)
-===Functions===
+;Functions
 * [[somCheckId]]
 * [[somIdFromString]]
 * [[somStringFromId]]
 * [[somCompareIds]]
 * [[somTotalRegIds]]
 * [[somSetExpectedIds]]
 * [[somUniqueKey]]
 * [[somBeginPersistentIds]]
 * [[somEndPersistentIds]]
-[[Category:SOM Kernel]]
+[[Category:SOM function]]