Skip to content
Snippets Groups Projects
Commit 02eaab2e authored by rtoy's avatar rtoy
Browse files

Correct docstring for OCTETS-TO-STRING to reflect what actually

happens.
parent b45fb97e
No related branches found
No related tags found
No related merge requests found
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
;;; domain. ;;; domain.
;;; ;;;
(ext:file-comment (ext:file-comment
"$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/extfmts.lisp,v 1.40 2010/09/06 19:01:56 rtoy Exp $") "$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/extfmts.lisp,v 1.41 2010/09/08 02:58:06 rtoy Rel $")
;;; ;;;
;;; ********************************************************************** ;;; **********************************************************************
;;; ;;;
...@@ -921,11 +921,13 @@ character and illegal outputs are replaced by a question mark.") ...@@ -921,11 +921,13 @@ character and illegal outputs are replaced by a question mark.")
the length of String). If the string is not large enough to hold the length of String). If the string is not large enough to hold
all of characters, then some octets will not be converted. A State all of characters, then some octets will not be converted. A State
may also be specified; this is used as the state of the external may also be specified; this is used as the state of the external
format. format. An error method may also be specified by Error, which
defaults to NIL to mean the default handling of conversion errors is
done.
Four values are returned: the string, the number of characters read, Four values are returned: the string, the position of where the next
the number of octets actually consumed and the new state of the character would be read into the string, the number of octets
external format." actually consumed and the new state of the external format."
(declare (type (simple-array (unsigned-byte 8) (*)) octets) (declare (type (simple-array (unsigned-byte 8) (*)) octets)
(type kernel:index start s-start) (type kernel:index start s-start)
(type (or kernel:index null) end) (type (or kernel:index null) end)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment