X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref.sgml;h=827ac079f6e3e39f5102540b8a8964bc3d1c2c59;hb=de11286b135675af1ef6f93af709bf8755158201;hp=d8d70c04e421e0c14a3c7734bf3a30997caa00ff;hpb=267d85c58ea3dac5081b20e8ec8701c8dfb009c3;p=uffi.git
diff --git a/doc/ref.sgml b/doc/ref.sgml
index d8d70c0..827ac07 100644
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -96,8 +96,12 @@ dereferenced :char pointer returns an character.
pointer returns an character.
- :byte - Unsigned 8-bits. A
+ :byte - Signed 8-bits. A
dereferenced :byte pointer returns an integer.
+
+
+ :unsigned-byte - Unsigned 8-bits. A
+dereferenced :unsigned-byte pointer returns an integer.
:short - Signed 16-bits.
@@ -884,7 +888,7 @@ can be freed.
size
- An optional size parameter. If specified, allocates and returns an
+ An optional size parameter that is evaluated. If specified, allocates and returns an
array of type that is size members long. This parameter is evaluated.
@@ -1046,6 +1050,61 @@ much better with static allocation.
+
+
+ size-of-foreign-type
+ Returns the number of data bytes used by a foreign object type.
+
+ Macro
+
+
+ Syntax
+
+ size-of-foreign-type ftype
+
+
+
+ Arguments and Values
+
+
+ ftype
+
+ A foreign type specifier. This parameter is evaluated.
+
+
+
+
+
+
+ Description
+
+ Returns the number of data bytes used by a foreign object type. This does not include any Lisp storage overhead.
+
+
+
+ Examples
+
+
+(size-of-foreign-object :unsigned-byte)
+=> 1
+(size-of-foreign-object 'my-100-byte-vector-type)
+=> 100
+
+
+
+
+ Side Effects
+ None.
+
+ Affected by
+ None.
+
+
+ Exceptional Situations
+ None.
+
+
+
pointer-address