Home Explore Help
Sign In
blitz
/
blitz3d
mirror of https://github.com/blitz-research/blitz3d.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: master
Branches Tags
blitz3d
/
_release
/
help
/
commands
/
2d_commands
/
ReadShort.htm

ReadShort.htm 2.3 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <title>Blitz3D Docs</title>
    4. 

  4. <link rel=stylesheet href=../css/commands.css type=text/css>
    5. 

  5. </head>
    6. 

  6. <body>
    7. 

  7. <h1>ReadShort (filehandle/stream)</h1>
    8. 

  8. <h1>Parameters</h1>
    9. 

  9. <table>
    10. 

  10. <tr>
    11. 

  11. <td>
    12. 

  12. filehandle/stream = a valid variable set with the OpenFile, ReadFile command,  or OpenTCPStream (v1.52+)
<br />
    13. 

  13. The value returned is an integer in the range 0-65535.
    14. 

  14. </td>
    15. 

  15. </tr>
    16. 

  16. </table>
    17. 

  17. <h1>Description</h1>
    18. 

  18. <table>
    19. 

  19. <tr>
    20. 

  20. <td>
    21. 

  21. Once you've opened a disk file (or stream) for reading, use this command  to read a single short integer (16bit) value from the file. Note, each value  written uses 2 bytes of disk space and is written least significant byte first.  Reading beyond the end of file does not result in an error, but each value read  will be zero.

<br />
    22. 

  22. 
<br />
    23. 

  23. Streams can only be used in Blitz Basic v1.52 or greater.
    24. 

  24. </td>
    25. 

  25. </tr>
    26. 

  26. </table>
    27. 

  27. <h1><a href=../2d_examples/ReadShort.bb>Example</a></h1>
    28. 

  28. <table>
    29. 

  29. <tr>
    30. 

  30. <td>
    31. 

  31. ; Reading and writing a file using ReadShort and WriteShort functions
<br />
    32. 

  32. 
<br />
    33. 

  33. ; Initialise some variables for the example
<br />
    34. 

  34. Int1% = 10 ; store 10
<br />
    35. 

  35. Int2% = 365 ; store 365
<br />
    36. 

  36. Int3% = 32767 ; 32767 is the largest positive Short Integer Value in BlitzBasic  )
<br />
    37. 

  37. Int4% = -32768 ; -32768 the largest negative Short Integer Value in BlitzBasic  )
<br />
    38. 

  38. 
<br />
    39. 

  39. ; Open a file to write to
<br />
    40. 

  40. fileout = WriteFile("mydata.dat")
<br />
    41. 

  41. 
<br />
    42. 

  42. ; Write the information to the file
<br />
    43. 

  43. WriteShort( fileout, Int1 )
<br />
    44. 

  44. WriteShort( fileout, Int2 )
<br />
    45. 

  45. WriteShort( fileout, Int3 )
<br />
    46. 

  46. WriteShort( fileout, Int4 )
<br />
    47. 

  47. 
<br />
    48. 

  48. ; Close the file
<br />
    49. 

  49. CloseFile( fileout )
<br />
    50. 

  50. 
<br />
    51. 

  51. ; Open the file to Read
<br />
    52. 

  52. filein = ReadFile("mydata.dat")
<br />
    53. 

  53. 
<br />
    54. 

  54. Read1 = ReadShort( filein )
<br />
    55. 

  55. Read2 = ReadShort( filein )
<br />
    56. 

  56. Read3 = ReadShort( filein )
<br />
    57. 

  57. Read4 = ReadShort( filein )
<br />
    58. 

  58. 
<br />
    59. 

  59. ; Close the file once reading is finished
<br />
    60. 

  60. CloseFile( filein )
<br />
    61. 

  61. 
<br />
    62. 

  62. Print "Short Integer Data Read From File - mydata.dat "
<br />
    63. 

  63. Print Read1
<br />
    64. 

  64. Print Read2
<br />
    65. 

  65. Print Read3
<br />
    66. 

  66. Print Read4
<br />
    67. 

  67. 
<br />
    68. 

  68. WaitKey()
<br />
    69. 

  69. 

  70. </td>
    71. 

  71. </tr>
    72. 

  72. </table>
    73. 

  73. <br>
    74. 

  74. <a target=_top href=../index.htm>Index</a><br>
    75. 

  75. <br>
    76. 

  76. Click <a href=http://www.blitzbasic.co.nz/b3ddocs/command.php?name=ReadShort&ref=comments target=_blank>here</a> to view the latest version of this page online</body>
    77. 

  77. </html>
    78.