Differences

This shows you the differences between two versions of the page.

--- doc:lua_make-your-own-scripts [2014/10/13 18:20] – [The IO Commands] admin
+++ doc:lua_make-your-own-scripts [2014/10/13 18:46] – admin
@@ Line 186: / Line 186: @@
-=== ioInput(file name ,file_extension,message) ===
+=== ioInput(file_name ,file_extension,message) ===
@@ Line 227: / Line 227: @@
-\\
+=== loadbuffer ===
+  len, newfilename= loadbuffer(start , filelen , file_name , file_extension , message)
+Reads the file "file_name" into the telegram buffer starting at position "start" by reading "filelen" number of bytes.
+The data source can be defined as explained for the ioInput command.
+The number of bytes read will be returned in "len", a negative value means a load error
+The following conditions apply:
+  * The selected filename will be returned in "filename".
+  * If filename is 0, the whole file will be read. If the length exceeds the telegram length, an error will be raised.
+=== savebuffer ===
+  len, newfilename = savebuffer(start , filelen , file_name , file_extension , message)
+Writes the telegram buffer starting at position "start" by reading "filelen" number of bytes into the file "filename".
+The number of bytes written will be returned in "len", a negative value means a load error
+The following conditions apply:
+  * The selected file name will be returned in "filename".
+  * If len is 0, the whole telegram buffer will be written.
+=== setbuffer ===
+  setBuffer(bufferNr , newSize )
+Changes the actual buffer used to buffer number "buffernr". OOBD supports 10 buffers, counted from 0 to 9. The startup buffer is nr. 0.
+If newsize is <> 0, the old buffer is deleted and new memory with size newmem is allocated
+=== copyBuffer ===
+  copyBuffer(bufferNr )
+Copies the content of buffer  "bufferNr" into the actual buffer.
+=== BlitBuffer ===
+  BlitBuffer(frombuffer , startpos , topos , blocklen  )
+Copies a memory block  from the buffer "frombuffer" starting at position "startpos" to the actual buffer to position "topos" with the length of "blocklen" bytes.
+In case the buffer len needs to be bigger, the buffer len is increased accourdingly.
+=== SetBufferLen ===
+ newSize= SetBufferLen( newSize)
+All other buffer commands can increase the 'len' of a buffer, but none of them can make a buffer shorter, except SetBufferLen.
+SetBufferLen sets the 'len' of the current Buffer to 'newSize'.
+The success of the SetBufferLen - operation is returned as function result as follows:
+^  input value of newSize  ^  return value   ^
+|  < = 0                    | available size of the buffer in bytes. This can be used to read the real allocated memory size of that buffer  |
+|  1.. available size      | new available size (= requested size)  |
+|  > available size        | available size of the buffer as **negative value ** . This is a fault condition |
+As seen, a negative value given back indicates a fault condition, all other returned values are positive.
+=== SendBuffer ===
+Sends the actual buffer
 ====  Miscellaneous  Commands ====