|Copyright||(c) The University of Glasgow 2001|
|License||BSD-style (see the file libraries/base/LICENSE)|
Unsafe API Only.
This function extracts the pointer component of a foreign pointer. This is a potentially dangerous operations, as if the argument to
unsafeForeignPtrToPtr is the last usage occurrence of the given foreign pointer, then its finalizer(s) will be run, which potentially invalidates the plain pointer just obtained. Hence,
touchForeignPtr must be used wherever it has to be guaranteed that the pointer lives on - i.e., has another usage occurrence.
To avoid subtle coding errors, hand written marshalling code should preferably use
withForeignPtr rather than combinations of
touchForeignPtr. However, the latter routines are occasionally preferred in tool generated marshalling code.
© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).