SomCompareIds: Difference between revisions

Revision as of 15:48, 19 January 2017

This function determines whether two SOM IDs represent the same string.

Syntax

somId    id1;
somId    id2;
int      rc;

rc = somCompareIds(id1, id2);

Parameters

id1 (somId): The first SOM ID to be compared.
id2 (somId): The second SOM ID to be compared.

Return Code

rc (int)

1 Returns 1 if the two input IDs represent strings that are equal.
0 Returns 0 if the two input IDs represent strings that are not equal.

Remarks

This function returns 1 if the two input IDs represent strings that are equal; otherwise, it returns 0.

Example Code

#include <som.h>
main()
{
   somId id1, id2, id3;

   somEnvironmentNew();
   id1 = somIdFromString("this");
   id2 = somIdFromString("that");
   id3 = somIdFromString("this");

   SOM_Test(somCompareIds(id1, id3));
   SOM_Test(!somCompareIds(id1, id2));
}

@@ Line 1: / Line 1: @@
-==Description==
 This function determines whether two SOM IDs represent the same string.
@@ Line 10: / Line 9: @@
 rc = somCompareIds(id1, id2);
 </PRE>
-==Parameters==
-;  id1 (somId) : The first SOM ID to be compared.
-; id2 (somId) : The second SOM ID to be compared.
+===Parameters===
+;id1 (somId) : The first SOM ID to be compared.
-==Return Code==
+;id2 (somId) : The second SOM ID to be compared.
-;  rc (int) :
+===Return Code===
+;rc (int):
 * 1  Returns 1 if the two input IDs represent strings that are equal.
 * 0  Returns 0 if the two input IDs represent strings that are not equal.
 ==Remarks==
@@ Line 26: / Line 23: @@
 ==Example Code==
 <PRE>
 #include <som.h>
@@ Line 45: / Line 41: @@
 ==Related==
 ===Data Structures===
-* [[somId (sombtype.h)
+*somId (sombtype.h)
 ===Functions===
-* [[somCheckId]]
+*[[somCheckId]]
-* [[somRegisterId]]
+*somRegisterId
-* [[somIdFromString]]
+*somIdFromString
-* [[somStringFromId]]
+*somStringFromId
-* [[somTotalRegIds]]
+*somTotalRegIds
-* [[somSetExpectedIds]]
+*somSetExpectedIds
-* [[somUniqueKey]]
+*somUniqueKey
-* [[somBeginPersistentIds]]
+*[[somBeginPersistentIds]]
-* [[somEndPersistentIds]]
+*somEndPersistentIds
-[[Category:The OS/2 API Project]]
+[[Category:The OS/2 API Project]][[Category:SOM Kernel]]
-[[Category:SOM Kernel]]