SomGetGlobalEnvironment: Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:somGetGlobalEnvironment}} | {{DISPLAYTITLE:somGetGlobalEnvironment}} | ||
This function returns a pointer to the current global Environment structure. | This function returns a pointer to the current global Environment structure. | ||
==Syntax== | ==Syntax== | ||
Environment *rc; | |||
Environment *rc; | rc = somGetGlobalEnvironment(); | ||
rc = somGetGlobalEnvironment(); | |||
==Parameters== | ==Parameters== | ||
==Return Code== | ==Return Code== | ||
; rc (Environment *) | ;rc (Environment *): A pointer to the current global Environment structure. | ||
==Remarks== | ==Remarks== | ||
This function returns a pointer to the current global Environment structure. This structure can be passed to methods that require an (Environment *) argument. The caller can determine if the called method has raised an exception by testing whether | This function returns a pointer to the current global Environment structure. This structure can be passed to methods that require an (Environment *) argument. The caller can determine if the called method has raised an exception by testing whether | ||
ev->exception._major != NO_EXCEPTION | ev->exception._major != NO_EXCEPTION | ||
If an exception has been raised, the caller can retrieve the name and value of the exception using the somExceptionId and somExceptionValue methods. | |||
If an exception has been raised, the caller can retrieve the name and value of the exception using the somExceptionId and somExceptionValue methods. | |||
==Example Code== | ==Example Code== | ||
| Line 24: | Line 20: | ||
==Related== | ==Related== | ||
;Data Structures | |||
* Environment (somcorba.h) | * Environment (somcorba.h) | ||
;Functions | |||
* [[somExceptionId]] | *[[somExceptionId]] | ||
* [[somExceptionValue]] | *[[somExceptionValue]] | ||
* [[somExceptionFree]] | *[[somExceptionFree]] | ||
* [[somSetException]] | *[[somSetException]] | ||
[[Category:SOM | [[Category:SOM function]] | ||
Latest revision as of 04:54, 6 May 2020
This function returns a pointer to the current global Environment structure.
Syntax
Environment *rc; rc = somGetGlobalEnvironment();
Parameters
Return Code
- rc (Environment *)
- A pointer to the current global Environment structure.
Remarks
This function returns a pointer to the current global Environment structure. This structure can be passed to methods that require an (Environment *) argument. The caller can determine if the called method has raised an exception by testing whether
ev->exception._major != NO_EXCEPTION
If an exception has been raised, the caller can retrieve the name and value of the exception using the somExceptionId and somExceptionValue methods.
Example Code
See function somSetException.
Related
- Data Structures
- Environment (somcorba.h)
- Functions