Promotic
WikipediaLinkedInYoutubeTwitterFacebook

SaveToFile - method of object PmBuffer

Description:
Writing values from data block into a binary file.
Syntax:
Long SaveToFile(Long nOffset, String sFile, [Long nFileOffset], [Long nLength])
Calling:
nWriteBytes = PmBuffer.SaveToFile(nOffset, sFile, nFileOffset, nLength)
Parameters:
nOffset(Long) Defines the position of read value in the data block.

The read value must be inside the data block. The item is read either whole or not read at all.

>= 0 - Index (in bytes, zero-based index) in data block.
-4 - The internal automatic position is used (see AutoOffset). It points behind the last read or written value and increases continually.

If the items are read/written one by one then it is not necessary to define the position, but it is handy to use this automated positioning.

sFile(String) The file name with the path. If a full path is not entered, then it is completed relative to the application file folder.

It is recommended to use the PROMOTIC path syntax - see PROMOTIC path to files and folders.

nFileOffset[optional] (Long) Defines the position of written value in the binary file in bytes. The value 0 (default) means writing from the beginning of the file.
nLength[optional] (Long) Defines the number of written bytes.
>=0 - Number (count) in bytes
-1 (default) - Writing all values up to the end of the data block.
-2 - Writing all values up to the end of the data block and then sets the end of the file.
Return Values:
Returns the number of really written bytes
Note:
This method is not functional for Web panels.
See also:
Writing into file:
For inverse example see Reading from file.
JavaScriptVBScriptSelect and copy to clipboard

var nSize;
var oBuf = Pm.CreatePmBuffer();
oBuf.SetSize(0);
oBuf.SetInt16(-2, 0x5060);
oBuf.SetInt8(-2, 0x70);
nSize = oBuf.SaveToFile(0, "#data:Test.bin", 0, -1);

History:
Pm9.00.05: Created
PROMOTIC 9.0.6 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice