diff options
| author | Kaz Kylheku <kaz@kylheku.com> | 2021-07-02 06:35:41 -0700 |
|---|---|---|
| committer | Kaz Kylheku <kaz@kylheku.com> | 2021-07-02 06:35:41 -0700 |
| commit | 2fa5d2ecd422011cd83c36e78b3375216f073ae1 (patch) | |
| tree | 3202271b326616957d9f4abb0c0c2d004bebc85c | |
| parent | b5d6ead3ee2bf101fd19c0fb5ddc6ccd253e2d57 (diff) | |
| download | txr-2fa5d2ecd422011cd83c36e78b3375216f073ae1.tar.gz txr-2fa5d2ecd422011cd83c36e78b3375216f073ae1.tar.bz2 txr-2fa5d2ecd422011cd83c36e78b3375216f073ae1.zip | |
doc: cptr-put does not exist.
* txr.1: There is no cptr-put function; it is called cptr-out.
The last paragraph refers to cptr-out and it is referenced
elsewhere. It has to be cptr-out because it implements the
"out semantics" in FFI conversion which pairs with "put";
cptr-put would be a different function, which is not currently
implemented.
* stdlib/doc-syms.tl: Updated.
| -rw-r--r-- | stdlib/doc-syms.tl | 2 | ||||
| -rw-r--r-- | txr.1 | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/stdlib/doc-syms.tl b/stdlib/doc-syms.tl index ed817076..829e418a 100644 --- a/stdlib/doc-syms.tl +++ b/stdlib/doc-syms.tl @@ -419,7 +419,7 @@ ("cptr-int" "N-015139D6") ("cptr-null" "N-01CB17AB") ("cptr-obj" "N-013139D1") - ("cptr-put" "N-00513A38") + ("cptr-out" "N-005139EC") ("cptr-size-hint" "N-024CD90F") ("cptr-type" "N-03B1F90C") ("cptr-zap" "N-00913A85") @@ -59274,11 +59274,11 @@ The argument may not be a variable length type, such as an array of unspecified size. -Note: the +Note: the functions .code cptr-get and .code cptr-out -is useful in simplifying the interaction with "semi-opaque" foreign objects: +are useful in simplifying the interaction with "semi-opaque" foreign objects: objects which serve as a API handles that are treated as opaque pointers in API argument calls, but which expose some internal members that the application must access directly. The @@ -59289,13 +59289,13 @@ necessary. Under this technique, the description of the foreign object need not be complete. Structure members which occur after the last member that the application is interested in need not be described in the FFI type. -.coNP Function @ cptr-put +.coNP Function @ cptr-out .synb -.mets (cptr-put < cptr < obj <> [ type ]) +.mets (cptr-out < cptr < obj <> [ type ]) .syne .desc The -.code cptr-put +.code cptr-out function converts a Lisp value into a C representation, which is stored at the memory location denoted by .metn cptr , |