summaryrefslogtreecommitdiffstats
path: root/Doc/api/api.tex
diff options
context:
space:
mode:
authorAndrew M. Kuchling <amk@amk.ca>2000-07-13 23:58:16 (GMT)
committerAndrew M. Kuchling <amk@amk.ca>2000-07-13 23:58:16 (GMT)
commit8c46b30e0a9dc91b56cec1d1204069c47a64f217 (patch)
treefadb2109f39fea60f754e23bdcfa66c2a8896c9f /Doc/api/api.tex
parent06051edc0d4987994ccd9d578210a1fe1fa1d13a (diff)
downloadcpython-8c46b30e0a9dc91b56cec1d1204069c47a64f217.zip
cpython-8c46b30e0a9dc91b56cec1d1204069c47a64f217.tar.gz
cpython-8c46b30e0a9dc91b56cec1d1204069c47a64f217.tar.bz2
Document PyObject_AsFileDescriptor
Diffstat (limited to 'Doc/api/api.tex')
-rw-r--r--Doc/api/api.tex7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 31ba95e..367cb06 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -1419,6 +1419,13 @@ failure. This is the equivalent of the Python statement \samp{del
\var{o}[\var{key}]}.
\end{cfuncdesc}
+\begin{cfuncdesc}{int}{PyObject_AsFileDescriptor}{PyObject *o}
+Derives a file-descriptor from a Python object. If the object
+is an integer or long integer, its value is returned. If not, the
+object's \method{fileno()} method is called if it exists; the method
+must return an integer or long integer, which is returned as the file
+descriptor value. Returns \code{-1} on failure.
+\end{cfuncdesc}
\section{Number Protocol \label{number}}