SomExceptionId: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:somExceptionId}} | {{DISPLAYTITLE:somExceptionId}} | ||
This function gets the name of the exception contained in an Environment structure. | This function gets the name of the exception contained in an Environment structure. | ||
==Syntax== | ==Syntax== | ||
Environment *env; | |||
Environment *env; | string rc; | ||
string rc; | |||
rc = somExceptionId(env); | |||
rc = somExceptionId(env); | |||
==Parameters== | ==Parameters== | ||
; env (Environment *) : A pointer to an Environment structure containing an exception | ;env (Environment *) : A pointer to an Environment structure containing an exception | ||
==Return Code== | ==Return Code== | ||
; rc (string) : Returns the name of the exception contained in the specified Environment structure, as a string. | ;rc (string) : Returns the name of the exception contained in the specified Environment structure, as a string. | ||
==Remarks== | ==Remarks== | ||
This function returns the name of the exception contained in the specified Environment structure. | This function returns the name of the exception contained in the specified Environment structure. | ||
==Example Code== | ==Example Code== | ||
| Line 23: | Line 21: | ||
==Related== | ==Related== | ||
;Data Structures | |||
* string (somcorba.h) | * string (somcorba.h) | ||
* Environment (somcorba.h) | * Environment (somcorba.h) | ||
;Functions | |||
* [[somExceptionValue]] | * [[somExceptionValue]] | ||
* [[somExceptionFree]] | * [[somExceptionFree]] | ||
* [[somSetException]] | * [[somSetException]] | ||
* [[somGetGlobalEnvironment]] | * [[somGetGlobalEnvironment]] | ||
[[Category:SOM Kernel]] | [[Category:SOM Kernel]] | ||
Latest revision as of 18:31, 12 October 2022
This function gets the name of the exception contained in an Environment structure.
Syntax
Environment *env; string rc; rc = somExceptionId(env);
Parameters
- env (Environment *)
- A pointer to an Environment structure containing an exception
Return Code
- rc (string)
- Returns the name of the exception contained in the specified Environment structure, as a string.
Remarks
This function returns the name of the exception contained in the specified Environment structure.
Example Code
See function somSetException.
Related
- Data Structures
- string (somcorba.h)
- Environment (somcorba.h)
- Functions