suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix docs for list->cblock and vector->cblock

Browse Source
This commit is contained in:
Matthew Flatt 2017-08-19 19:01:30 -06:00
parent 52e7267273
commit c87cdf5988
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
pkgs/racket-doc/scribblings/foreign/misc.scrbl
View File

@ -3,17 +3,29 @@
@title{Miscellaneous Support}
@defproc[(list->cblock [lst list?] [type ctype?]) any]{
@defproc[(list->cblock [lst list?]
[type ctype?]
[expect-length (or/c exact-nonnegative-integer? #f) #f])
cpointer?]{
Allocates a memory block of an appropriate size, and initializes it
using values from @racket[lst] and the given @racket[type]. The
Allocates a memory block of an appropriate size---using
@racket[malloc] with @racket[type] and @racket[(length lst)]---and
initializes it using values from @racket[lst]. The
@racket[lst] must hold values that can all be converted to C values
according to the given @racket[type].}
according to the given @racket[type].
If @racket[expect-length] is not @racket[#f] and not the same as
@racket[(length lst)], then an exception is raised instead of
allocating memory.}
@defproc[(vector->cblock [vec vector?] [type ctype?]) any]{
@defproc[(vector->cblock [vec vector?]
[type ctype?]
[expect-length (or/c exact-nonnegative-integer? #f) #f])
cpointer?]{
Like @racket[list->cblock], but for Racket vectors.}
Like @racket[list->cblock], but using values from a vector instead of
a list.}
@defproc[(vector->cpointer [vec vector?]) cpointer?]{