summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrank Wuerthwein <fkw@ucsd.edu>2009-02-08 16:18:56 +0000
committerFrank Wuerthwein <fkw@ucsd.edu>2009-02-08 16:18:56 +0000
commit08bdaffd7228995992bc7a3bb7abcce0cfb9cbac (patch)
tree8f9f913e92853c48f4f2a7036143458e578d7fef
parent0b23afb48f5f5cccf4c8f07283e5e710195a5780 (diff)
Update FetchBinaryURLAsync description
-rw-r--r--doc/lib/binaryXHR_js.html14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/lib/binaryXHR_js.html b/doc/lib/binaryXHR_js.html
index b5d1764..0f4cc9e 100644
--- a/doc/lib/binaryXHR_js.html
+++ b/doc/lib/binaryXHR_js.html
@@ -65,7 +65,7 @@ need to worry about them.</P>
<P>Load a binary file.</P>
<P>Arguments:</P>
<UL>
- <LI><P>url:string – URL from where to load the binary file.</P>
+ <LI><P>url:string - URL from where to load the binary file.</P>
</UL>
<P>Output:</P>
<UL>
@@ -77,14 +77,16 @@ need to worry about them.</P>
<P>Initiate an asynchronous binary load.</P>
<P>Arguments:</P>
<UL>
- <LI><P>url:string – URL from where to load the binary file.</P>
- <LI><P>callback:function(obj) – Pointer to the function that will
+ <LI><P>url:string - URL from where to load the binary file.</P>
+ <LI><P>callback:function(obj) - Pointer to the function that will
be called when the binary file has been loaded. He function will be
- given a single argument; an object of type BinaryFile.</P>
+ given a single argument; an object of type <A HREF="#BinaryFile">BinaryFile</A>.</P>
</UL>
<P>Output:</P>
<UL>
- <LI><P>None. The callback function will receive the loaded file.</P>
+ <LI><P>A reference to the <A HREF="http://www.w3.org/TR/XMLHttpRequest/">XMLHttpRequest</A> object.
+ It may be used to verify the status of the load or to implement timeouts.<BR>
+ The callback function will receive the loaded binary file.</P>
</UL>
<A NAME="BinaryFile">
<P CLASS="heading-2-western">Class BinaryFile</P>
@@ -189,7 +191,7 @@ the binary file.</P>
</TABLE>
</DIV>
<A NAME="InvalidBinaryFile">
-<P CLASS="heading-2-western">Class InvalidBinaryFile</P>
+<P CLASS="heading-2-western">Exception class InvalidBinaryFile</P>
</A>
<P>This is a helper exception class that can be thrown while loading the binary file.</P>
<P><BR></P>