mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-07 15:22:31 +01:00
Overhaul.
Author:halw Date:2011-03-07T16:49:40.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@829 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
@@ -1,22 +1,34 @@
|
||||
[[Property:title|eif_protect]]
|
||||
[[Property:weight|2]]
|
||||
[[Property:uuid|f335a229-93c4-4f3f-6fca-9c4c190745c4]]
|
||||
==SYNOPSYS==
|
||||
<code>
|
||||
'''#include "eif_hector.h"
|
||||
==Synopsis==
|
||||
|
||||
EIF_OBJECT eif_protect (EIF_REFERENCE''' ''ref''''');'''</code>
|
||||
<code lang="text">
|
||||
#include "eif_hector.h"
|
||||
|
||||
EIF_OBJECT eif_protect (EIF_REFERENCE ref);
|
||||
</code>
|
||||
|
||||
==Description==
|
||||
|
||||
The <code lang="text">eif_protect</code> function protects the Eiffel reference <code lang="text">ref</code> from the garbage collector. It keeps a reference on it so that the garbage collector does not collect it if it is not referenced from Eiffel any longer.
|
||||
|
||||
==Return value==
|
||||
|
||||
The <code lang="text">eif_protect</code> function returns an <code lang="text">EIF_OBJECT</code>. This <code lang="text">EIF_OBJECT</code> can be used later on to access <code lang="text">ref</code> with [[eif_access]].
|
||||
|
||||
==Conformance==
|
||||
|
||||
==DESCRIPTION==
|
||||
The '''eif_protect()''' function protects the Eiffel reference ''ref'' from the GC. It keeps a reference on it so that the Garbage Collector does not collect it if it is not referenced from Eiffel any longer.
|
||||
==RETURN VALUE==
|
||||
The '''eif_protect()''' function returns an EIF_OBJECT. This EIF_OBJECT can be used later on to access ''ref'' with '''eif_access ()'''.
|
||||
==CONFORMANCE==
|
||||
ISE Eiffel 4.4 and later.
|
||||
==COMPATIBILTY==
|
||||
It is equivalent to '''henter()''', which is deprecated.
|
||||
==SEE ALSO==
|
||||
'''eif_access'''(1), '''eif_adopt'''(1) , '''eif_wean'''(1).
|
||||
|
||||
==Compatibility==
|
||||
|
||||
<code lang="text">eif_protect</code> is equivalent to <code lang="text">henter</code>, which is deprecated.
|
||||
|
||||
|
||||
{{SeeAlso| <br/>
|
||||
[[eif_access]] <br/>
|
||||
[[eif_adopt]] <br/>
|
||||
[[eif_wean]] }}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user