Mercurial > cpython-lru_cache-weakref
diff Doc/api/api.tex @ 17057:797ebb7033d7 legacy-trunk
Finally fill in the documentation for the PyDict_Next() function. It is
different enough to actually require an explanation. ;-)
Fix a couple of PyDictObject* types that should be PyObject* types.
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Fri, 16 Mar 2001 15:41:29 +0000 |
| parents | 5280e8439d55 |
| children | f9a07e99907e |
line wrap: on
line diff
--- a/Doc/api/api.tex Fri Mar 16 11:50:43 2001 +0000 +++ b/Doc/api/api.tex Fri Mar 16 15:41:29 2001 +0000 @@ -3293,7 +3293,7 @@ raised. \end{cfuncdesc} -\begin{cfuncdesc}{int}{PyDict_SetItemString}{PyDictObject *p, +\begin{cfuncdesc}{int}{PyDict_SetItemString}{PyObject *p, char *key, PyObject *val} Inserts \var{value} into the dictionary using \var{key} @@ -3348,9 +3348,27 @@ \samp{len(\var{p})} on a dictionary.\bifuncindex{len} \end{cfuncdesc} -\begin{cfuncdesc}{int}{PyDict_Next}{PyDictObject *p, int *ppos, +\begin{cfuncdesc}{int}{PyDict_Next}{PyObject *p, int *ppos, PyObject **pkey, PyObject **pvalue} - +Iterate over all key-value pairs in the dictionary \var{p}. The +\ctype{int} referred to by \var{ppos} must be initialized to \code{0} +prior to the first call to this function to start the iteration; the +function returns true for each pair in the dictionary, and false once +all pairs have been reported. The parameters \var{pkey} and +\var{pvalue} should either point to \ctype{PyObject*} variables that +will be filled in with each key and value, respectively, or may be +\NULL. The dictionary \var{p} must not be mutated during iteration. +For example: + +\begin{verbatim} +PyObject *key, *value; +int pos = 0; + +while (PyDict_Next(self->dict, &pos, &key, &value)) { + /* do something interesting with the values... */ + ... +} +\end{verbatim} \end{cfuncdesc}
