SomIdFromString: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
string aString; | |||
string aString; | somId rc; | ||
somId rc; | |||
rc = somIdFromString(aString); | |||
rc = somIdFromString(aString); | |||
==Parameters== | ==Parameters== | ||
; aString (string) : The string to be converted to a SOM ID. | ;aString (string): The string to be converted to a SOM ID. | ||
==Return Code== | ==Return Code== | ||
; rc (somId) : Returns the SOM ID corresponding to the given text string. | ;rc (somId): Returns the SOM ID corresponding to the given text string. | ||
==Remarks== | ==Remarks== | ||
This function returns the SOM ID that corresponds to a given text string. | This function returns the SOM ID that corresponds to a given text string. | ||
Ownership of the somId returned by this function passes to the caller, which has the responsibility to subsequently free the | Ownership of the somId returned by this function passes to the caller, which has the responsibility to subsequently free the somId using SOMFree. | ||
somId using SOMFree. | |||
==Example Code== | ==Example Code== | ||
| Line 26: | Line 23: | ||
==Related== | ==Related== | ||
;Data Structures | |||
* somId (sombtype.h) | * somId (sombtype.h) | ||
* string (somcorba.h) | * string (somcorba.h) | ||
;Functions | |||
* [[somCheckId]] | * [[somCheckId]] | ||
* [[somRegisterId]] | * [[somRegisterId]] | ||
* [[somStringFromId]] | * [[somStringFromId]] | ||
* [[somCompareIds]] | * [[somCompareIds]] | ||
* [[somTotalRegIds]] | * [[somTotalRegIds]] | ||
* [[somSetExpectedIds]] | * [[somSetExpectedIds]] | ||
* [[somUniqueKey]] | * [[somUniqueKey]] | ||
* [[somBeginPersistentIds]] | * [[somBeginPersistentIds]] | ||
* [[somEndPersistentIds]] | * [[somEndPersistentIds]] | ||
[[Category:SOM | [[Category:SOM function]] | ||
Latest revision as of 04:55, 6 May 2020
This function returns the SOM ID corresponding to a given text string.
Syntax
string aString; somId rc; rc = somIdFromString(aString);
Parameters
- aString (string)
- The string to be converted to a SOM ID.
Return Code
- rc (somId)
- Returns the SOM ID corresponding to the given text string.
Remarks
This function returns the SOM ID that corresponds to a given text string.
Ownership of the somId returned by this function passes to the caller, which has the responsibility to subsequently free the somId using SOMFree.
Example Code
See function somBeginPersistentIds.
Related
- Data Structures
- somId (sombtype.h)
- string (somcorba.h)
- Functions