SaveToFile - method of the PmBuffer object

Description:

Writing values from data block into a binary file.

Syntax:

Long SaveToFile(Long nOffset, String sFile, [Long nFileOffset], [Long nLength])

Parameters:

nOffset	(Long) Specifies 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 the data block. -4 - The internal automatic position is used (see the AutoOffset property). It points behind the last read or written value. This operation shifts the internal automatic position behind the read/written value. If the items are read/written one by one then it is not necessary to define the position manually, but it is better 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 folder. It is recommended to use the PROMOTIC path syntax - see PROMOTIC path to files and folders.
nFileOffset	[optional] (Long) Specifies the position of written value in the binary file in bytes. The 0 value (default) means writing from beginning of the file.
nLength	[optional] (Long) Specifies the number of written bytes. >=0 - The 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 value:

Returns the number of really written bytes

Note:

This method is not functional in Web panels.

Example:

Writing into the file. For inverse example see Example.

JavaScriptVBScriptSelect and copy to clipboard



var nSize;

var oBuf = Pm.CreatePmBuffer();

oBuf.SetInt16(-2, 0x5060);

oBuf.SetInt8(-2, 0x70);

nSize = oBuf.SaveToFile(0, "#data:Test.bin", 0, -1);