SOM InitEnvironment: Difference between revisions
Created page with "This macro initializes a local Environment structure. ==Syntax== <PRE> Environment *env; SOM_InitEnvironment(env); </PRE> ==Parameters== ; env (Environment *) : A point..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This macro initializes a local Environment structure. | {{DISPLAYTITLE:SOM_InitEnvironment}} | ||
This macro initializes a local Environment structure. | |||
==Syntax== | ==Syntax== | ||
Environment *env; | |||
Environment *env; | SOM_InitEnvironment(env); | ||
SOM_InitEnvironment(env); | |||
==Parameters== | ==Parameters== | ||
; env (Environment *) : A pointer to the Environment structure to be initialized. | ;env (Environment *): A pointer to the Environment structure to be initialized. | ||
==Return Code== | ==Return Code== | ||
==Remarks== | ==Remarks== | ||
The SOM_InitEnvironment macro initializes a locally declared Environment structure. This Environment structure can then be passed to methods as the Environment argument so that exception information can be returned without affecting the global environment. | The SOM_InitEnvironment macro initializes a locally declared Environment structure. This Environment structure can then be passed to methods as the Environment argument so that exception information can be returned without affecting the global environment. | ||
==Expansion== | ==Expansion== | ||
The SOM_InitEnvironment initializes an Environment structure to zero. | The SOM_InitEnvironment initializes an Environment structure to zero. | ||
==Example Code== | ==Example Code== | ||
| Line 28: | Line 27: | ||
==Related== | ==Related== | ||
;Macros | |||
* [[SOM_DestroyLocalEnvironment]] | * [[SOM_DestroyLocalEnvironment]] | ||
* [[SOM_CreateLocalEnvironment]] | * [[SOM_CreateLocalEnvironment]] | ||
* [[SOM_UninitEnvironment]] | * [[SOM_UninitEnvironment]] | ||
;Functions | |||
* [[somGetGlobalEnvironment]] | * [[somGetGlobalEnvironment]] | ||
[[Category:SOM | [[Category:SOM macro]] | ||
Latest revision as of 02:11, 6 May 2020
This macro initializes a local Environment structure.
Syntax
Environment *env; SOM_InitEnvironment(env);
Parameters
- env (Environment *)
- A pointer to the Environment structure to be initialized.
Return Code
Remarks
The SOM_InitEnvironment macro initializes a locally declared Environment structure. This Environment structure can then be passed to methods as the Environment argument so that exception information can be returned without affecting the global environment.
Expansion
The SOM_InitEnvironment initializes an Environment structure to zero.
Example Code
Environment ev; SOM_InitEnvironment(&ev); _myMethod(obj, &ev); ... SOM_UninitEnvironment(&ev);
Related
- Macros
- Functions