SomUniqueKey

This function returns the unique key associated with a SOM ID.

Syntax

somID            id;
unsigned long    rc;

rc = somUniqueKey(id);

Parameters

d (somID)

The SOM ID for which the unique key is needed. An unsigned long representing the unique key of the specified SOM ID.

Return Code

rc (unsigned long)

An unsigned long representing the unique key of the specified SOM ID.

Remarks

This function returns the unique key associated with a SOM ID. The unique key for a SOM ID is a number that uniquely represents the string that the SOM ID represents. The unique key for a SOM ID is the same as the unique key for another SOM ID only if the two SOM IDs represent the same string.

Example Code

#include <som.h>
main()
{
   unsigned long k1, k2;
   k1 = somUniqueKey(somIdFromString("abc"));
   k2 = somUniqueKey(somIdFromString("abc"));
   SOM_Test(k1 == k2);
}

Related

Data Structures

• somId (sombtype.h)

Functions

• somCheckId
• somRegisterId
• somIdFromString
• somStringFromId
• somCompareIds
• somTotalRegIds
• somSetExpectedIds
• somBeginPersistentIds
• somEndPersistentIds