Mercurial > cpython-lru_cache-weakref
diff Doc/api/api.tex @ 12353:54e80db49423 legacy-trunk
document PyErr_Format
| author | Jeremy Hylton <jeremy@alum.mit.edu> |
|---|---|
| date | Mon, 10 Apr 2000 18:40:57 +0000 |
| parents | 65bc5eaf47ce |
| children | 996eb3b3b33e |
line wrap: on
line diff
--- a/Doc/api/api.tex Mon Apr 10 18:35:49 2000 +0000 +++ b/Doc/api/api.tex Mon Apr 10 18:40:57 2000 +0000 @@ -858,6 +858,17 @@ You need not increment its reference count. \end{cfuncdesc} +\begin{cfuncdesc}{PyObject*}{PyErr_Format}{PyObject *exception, const char *format, ...} +This function sets the error indicator using a printf-style format +string. The first argument specifies the exception type and the +second argument specifies the format string for the exception. Any +subsequent arguments are converted to output by the C library's +\cfunction{vsprintf()} function. The buffer used internally by +PyErr_Format is 500 bytes long. The caller is responsible for +guaranteeing that the formatted output does not overflow the buffer. +The return value is always \NULL{}. +\end{cfuncdesc} + \begin{cfuncdesc}{void}{PyErr_SetNone}{PyObject *type} This is a shorthand for \samp{PyErr_SetObject(\var{type}, Py_None)}. \end{cfuncdesc}
