Document PyObject_AsFileDescriptor

akuchling · akuchling · commit 8c46b30e0a9d · 2000-07-13T23:58:16.000Z
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
@@ -1419,6 +1419,13 @@ \section{Object Protocol \label{object}}
 \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}}
 
diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat
@@ -539,6 +539,9 @@ PyNumber_Xor:PyObject*:o2:0:
 PyOS_GetLastModificationTime:long:::
 PyOS_GetLastModificationTime:char*:filename::
 
+PyObject_AsFileDescriptor:int::: 
+PyObject_AsFileDescriptor:PyObject*:o:0:
+
 PyObject_CallFunction:PyObject*::+1:
 PyObject_CallFunction:PyObject*:callable_object:0:
 PyObject_CallFunction:char*:format::
