SomCheckId: Difference between revisions

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().

@@ Line 1: / Line 1: @@
-==Description==
+{{DISPLAYTITLE:somCheckId}}
 This function registers a som ID.
 ==Syntax==
-<PRE>
+ somId    id;
-somId    id;
+ somId    rc;
-somId    rc;
+ rc = somCheckId(id);
-rc = somCheckId(id);
-</PRE>
 ==Parameters==
-;  id (somId) : The somId to be registered.
+;id (somId): The somId to be registered.
 ==Return Code==
-;  rc (somId) : The registered somId.
+;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==
@@ Line 24: / Line 21: @@
 ==Related==
-===Data Structures===
+;Data Structures
-*somId (sombtype.h)
+* somId (sombtype.h)
+;Methods
-===Methods===
+* [[somRegisterId]]
-*somRegisterId
+* [[somIdFromString]]
-*somFromString
+* [[somStringFromId]]
-*somStringFromId
+* [[somCompareIds]]
-*comCompareIds
+* [[somTotalRegIds]]
-*somTotalRegIds
+* [[somSetExpectedIds]]
-*somSetExpectedIds
+* [[somUniqueKey]]
-*somUniqueKey
+* [[somBeginPersistentIds]]
-*[[somBeginPersistentIds]]
+* [[somEndPersistentIds]]
-*somEndPersistentIds
-[[Category:The OS/2 API Project]][[Category:SOM Kernel]]
+[[Category:SOM function]]