Difference between revisions of "API File.NVM.Open"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Opens the existing file as a block of non-volatile memory
 
Opens the existing file as a block of non-volatile memory
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:File
 +
::NVM
 +
:::Open
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|STRING]] Filename''
 
''[[Variable types|STRING]] Filename''
 
:The name of an existing file to open
 
:The name of an existing file to open
  
===Return value===
+
==Return value==
 
[[Variable types|HANDLE]]
 
[[Variable types|HANDLE]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[C]">result = ::File.NVM.Open("filename")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::File.NVM.Open("filename")</pre>

Revision as of 21:14, 11 May 2013

<sidebar>API contents</sidebar> Opens the existing file as a block of non-volatile memory

Class hierarchy

File
NVM
Open

Parameters

STRING Filename

The name of an existing file to open

Return value

HANDLE

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::File.NVM.Open("filename")