[graphic-forms-cvs] r420 - trunk/docs/manual

[junrue at common-lisp.net]

Author: junrue
Date: Thu Dec 21 00:00:01 2006
New Revision: 420

Modified:
   trunk/docs/manual/gfs-symbols.xml
Log:
documented null-handle-p

Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml	(original)
+++ trunk/docs/manual/gfs-symbols.xml	Thu Dec 21 00:00:01 2006
@@ -228,6 +228,7 @@
       <reftopic>gfs:handle</reftopic>
       <reftopic>gfs:disposed-error</reftopic>
       <reftopic>gfs:disposed-p</reftopic>
+      <reftopic>gfs:null-handle-p</reftopic>
     </seealso>
   </class>
 
@@ -584,6 +585,30 @@
     </description>
   </function>
 
+  <function name="null-handle-p">
+    <syntax>
+      <arguments>
+        <argument name="handle">
+          <description>
+            A <emphasis>native handle</emphasis> represented within
+            Graphic-Forms using the CFFI :pointer type.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <refclhs>boolean</refclhs>
+      </return>
+    </syntax>
+    <description>
+      Returns T if <arg0/> is null (meaning that its foreign address is zero);
+      NIL otherwise.
+    </description>
+    <seealso>
+      <reftopic>gfs:handle</reftopic>
+      <reftopic>gfs:native-object</reftopic>
+    </seealso>
+  </function>
+
   <function name="make-point">
     <syntax>
       <arguments>
@@ -1157,6 +1182,7 @@
       <reftopic>gfs:dispose</reftopic>
       <reftopic>gfs:disposed-p</reftopic>
       <reftopic>gfs:disposed-error</reftopic>
+      <reftopic>gfs:null-handle-p</reftopic>
     </seealso>
   </slot-reader>