API File.Buffer.ReadArray: Difference between revisions

Revision as of 21:14, 11 May 2013

<sidebar>API contents</sidebar> Reads an array from the input stream, returns elements read

File

Buffer

ReadArray

HANDLE FileHandle

The handle of an open file

ARRAY Buffer

An array of some type to read from the file

ULONG Elements

Maximum number of elements to read

The default value for this parameter is: -1

ULONG Timeout

A number of milliseconds to wait for the data to be available

The default value for this parameter is: 0

Returns elements read

No additional information

Add to a calculation icon:

result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)

@@ Line 2: / Line 2: @@
 Reads an array from the input stream, returns elements read
+<div style="width:25%; float:right" class="toc">
+===Class hierarchy===
+:File
+::Buffer
+:::ReadArray
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''[[Variable types|HANDLE]] FileHandle''
 :The handle of an open file
@@ Line 18: / Line 25: @@
 :''The default value for this parameter is: '''''0'''
-===Return value===
+==Return value==
 [[Variable types|ULONG]]
 Returns elements read
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type ULONG
-* Add to a calculation icon: <pre class="brush:[C]">result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadArray(filehandle, _arraybuffer, elements, timeout)</pre>