summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorOlly Betts <olly@survex.com>2022-10-06 18:06:36 +1300
committerOlly Betts <olly@survex.com>2022-10-06 18:06:36 +1300
commit37c8185bd3665673151f934b55849766fa664dd3 (patch)
tree69bacbfdafa7d8a54fae2dee6eea0565af38ee46 /Doc
parent047928d670ac7c5fd530a66e76dd98597299ad4d (diff)
downloadswig-37c8185bd3665673151f934b55849766fa664dd3.tar.gz
Replace reference to SWIG_POINTER_EXCEPTION in docs
This has only been present for backward compatibility since 2006 and now has the value 0 so doesn't do anything, so don't use it as an example of a flag in the docs.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Manual/Python.html7
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/Manual/Python.html b/Doc/Manual/Python.html
index c1cc1796d..cc21bc011 100644
--- a/Doc/Manual/Python.html
+++ b/Doc/Manual/Python.html
@@ -5377,10 +5377,9 @@ int SWIG_ConvertPtr(PyObject *obj, void **ptr, swig_type_info *ty, int flags)</t
Converts a Python object <tt>obj</tt> to a C pointer. The result of the conversion is placed
into the pointer located at <tt>ptr</tt>. <tt>ty</tt> is a SWIG type descriptor structure.
<tt>flags</tt> is used to handle error checking and other aspects of conversion. It is the
-bitwise-or of several flag values including <tt>SWIG_POINTER_EXCEPTION</tt> and
-<tt>SWIG_POINTER_DISOWN</tt>. The first flag makes the function raise an exception on type
-error. The second flag additionally
-steals ownership of an object. Returns 0 on success and -1 on error.
+bitwise-or of several flag values including <tt>SWIG_POINTER_DISOWN</tt> (which steals
+ownership of the object) and <tt>SWIG_POINTER_NO_NULL</tt> (which makes the conversion fail
+if the C pointer would be <tt>NULL</tt>). Returns 0 on success and -1 on error.
</div>
<p>