API File.Buffer.ReadByte: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Reads a single byte from the input stream, -1 if empty | Reads a single byte from the input stream, -1 if empty | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:File | |||
::Buffer | |||
:::ReadByte | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] FileHandle'' | ''[[Variable types|HANDLE]] FileHandle'' | ||
:The handle of an open file | :The handle of an open file | ||
| Line 11: | Line 18: | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
==Return value== | |||
[[Variable types|INT]] | [[Variable types|INT]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type INT | * Declare a variable 'result' of type INT | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.Buffer.ReadByte(filehandle, timeout)</pre> | ||
Revision as of 21:14, 11 May 2013
<sidebar>API contents</sidebar> Reads a single byte from the input stream, -1 if empty
Class hierarchy
- File
- Buffer
- ReadByte
- Buffer
Parameters
HANDLE FileHandle
- The handle of an open file
ULONG Timeout
- A number of milliseconds to wait for the byte to be available
- The default value for this parameter is: 0
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type INT
- Add to a calculation icon:
result = ::File.Buffer.ReadByte(filehandle, timeout)