]> granicus.if.org Git - python/commitdiff
Added buffer_info() docs.
authorGuido van Rossum <guido@python.org>
Thu, 14 Aug 1997 19:50:37 +0000 (19:50 +0000)
committerGuido van Rossum <guido@python.org>
Thu, 14 Aug 1997 19:50:37 +0000 (19:50 +0000)
Doc/lib/libarray.tex
Doc/libarray.tex

index eb762516454a811b031f702f72f32c12356c7660..145bb4f702b2ce1444d17117f3e59fc603f7cbfd 100644 (file)
@@ -60,6 +60,16 @@ The length in bytes of one array item in the internal representation.
 Append a new item with value \var{x} to the end of the array.
 \end{funcdesc}
 
+\begin{funcdesc}{buffer_info}{}
+Return a tuple \code{(\var{address}, var{length})} giving the current
+memory address and the length in bytes of the buffer used to hold
+array's contents.  This is occasionally useful when working with
+low-level (and inherently unsafe) I/O interfaces that require memory
+addresses, such as certain \code{ioctl} operations.  The returned
+numbers are valid as long as the array exists and no length-changing
+operations are applied to it.
+\end{funcdesc}
+
 \begin{funcdesc}{byteswap}{x}
 ``Byteswap'' all items of the array.  This is only supported for
 integer values.  It is useful when reading data from a file written
index eb762516454a811b031f702f72f32c12356c7660..145bb4f702b2ce1444d17117f3e59fc603f7cbfd 100644 (file)
@@ -60,6 +60,16 @@ The length in bytes of one array item in the internal representation.
 Append a new item with value \var{x} to the end of the array.
 \end{funcdesc}
 
+\begin{funcdesc}{buffer_info}{}
+Return a tuple \code{(\var{address}, var{length})} giving the current
+memory address and the length in bytes of the buffer used to hold
+array's contents.  This is occasionally useful when working with
+low-level (and inherently unsafe) I/O interfaces that require memory
+addresses, such as certain \code{ioctl} operations.  The returned
+numbers are valid as long as the array exists and no length-changing
+operations are applied to it.
+\end{funcdesc}
+
 \begin{funcdesc}{byteswap}{x}
 ``Byteswap'' all items of the array.  This is only supported for
 integer values.  It is useful when reading data from a file written