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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
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====
 +
[[API File|File]]
 +
:[[API File.NVM|NVM]]
 +
::[[API 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===
 
[[Variable types|HANDLE]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|HANDLE]]
  
===Detailed description===
+
''<span style="color:red;">No additional information</span>''
''No additional information''
 
  
===Examples===
+
 
====Calling in a calculation====
+
==Detailed description==
 +
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===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>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<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")

No additional examples