Promotic
WikipediaLinkedInYoutubeTwitterFacebook

FileBinaryWrite - method of object Pm

Description:
Storing the content of the variable of the Array type (array of values) into the binary file
Syntax:
FileBinaryWrite(sFile As String, nOffset As Long, nAttr As Long, Values As Variant) As Long
Calling:
n = Pm.FileBinaryWrite(sFile, nOffset, nAttr, Values)
Parameters:
sFile(String) file name (with the path). If a full path is not entered, it is completed relatively according to the application file folder.

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

nOffset(Long) Byte offset that sets the beginning of writing into the binary file (e.g. 10 means writing into 10th byte of the file). If the value is -1, offset is set to the end of the file. The parameter has the importance only for nAttr=1, otherwise nOffset=0 must be set.
nAttr(Long) Bit attribute. It can be 0 or a sum of the following applicable values.
1 - If the file already exists, its content will be overwritten from the offset (see the nOffset parameter). If the value 1 is not set, the entire content of the file will be cleared before writing.
2 - Value of the String type (text string) is stored without the string end character. If the value 2 is not set, the string is stored into the file and one more byte with the value 0 is added (the string end character).
Values(Variant) Variable of the Array type whose items are stored.
Return Values:
Returns the number of written bytes (Caution, not the number of items!). If an error occurred, the method returns the negative number.
Note:

Individual array items are stored according to their data type in this matter:

Data type: Number of stored bytes into the file:
Byte 1
Integer 2
Long 4
Date 8
Bool 1
Single 4
Double 8
String number of characters + 1 (1 for the character 0 only if nAttr=2 is not set)
 
This method is not functional for Web Panels.
Example:
Writing the array of 4 items into the file. 1st item is of the Long type and thus 4 bytes are written. 2nd item is of the String type and thus 5 bytes are written (including ending 0), 3rd item if of the Double type and thus 8 bytes are written and the last 4th item if of the Byte, and thus only one byte is written. Thus altogether 4+5+8+1 bytes are written into the file.
Dim Val(3), length
Val(0) = CLng(1)
Val(1) = "test"
Val(2) = Pm.CDbl(3.14)
Val(3) = true
length = Pm.FileBinaryWrite("#data:File.bin", 0, 0, Val)
If length = 4+5+8+1 Then
  Pm.Debug "Data have successfully been written"
Else
  Pm.Debug "Writing data failed ! length=" & length
End If
Navigation:
 
- Pm
 
- Abs
- Cos
- E
- Exp
- FileBinaryWrite
 
 
- LN2
- PI
- Pow
- Sin
- Tan
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice