Jump to content

Development Environment Event Callback VIs: Difference between revisions

From LabVIEW Wiki
m Category reorg
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{TOCright}}Development Environment Callback VIs are VIs that LabVIEW looks for and attempts to run when certain development environment events occur. Most of these are installed as part of the Dataloging and Supervisory Control module (DSC) and are used for starting and stoping the DSC services that need to run along side LabVIEW. The lv_new.vi callback is used by LabVIEW to launch the "New" Dialog that includes a template browser.
{{TOCright}}Development Environment Callback VIs are VIs that LabVIEW looks for and attempts to run when certain development environment events occur. Most of these are installed as part of the Dataloging and Supervisory Control module (DSC) and are used for starting and stoping the DSC services that need to run along side LabVIEW. The lv_new.vi callback is used by LabVIEW to launch the "New" Dialog that includes a template browser.
== The VIs ==
===lv_about.vi - LabVIEW About Callback===
===lv_about.vi - LabVIEW About Callback===
* '''Description:''' When Help >> About LabVIEW is selected, LabVIEW will launch this VI, if present.
* '''Description:''' When Help >> About LabVIEW is selected, LabVIEW will launch this VI, if present.
* '''Location:''' ./resource/plugins/lv_about.vi
* '''Location:''' ./resource/plugins/lv_about.vi
* '''Invoke Mechanism:''' Call By Reference
* '''Invoke Mechanism:''' Call By Reference
===lv_exit.vi - LabVIEW Exiting Callback===
===lv_exit.vi - LabVIEW Exiting Callback===
* '''Location:''' ./resource/plugins/lv_exit.vi
* '''Location:''' ./resource/plugins/lv_exit.vi
* '''Invoke Mechanisim:''' Call By Reference
* '''Invoke Mechanisim:''' Call By Reference
* '''Return Value:''' 0:Don't Exit; 1:Exit
* '''Return Value:''' 0:Don't Exit; 1:Exit
===lv_init.vi - LabVIEW Initialization Callback===
===lv_init.vi - LabVIEW Initialization Callback===
* '''Description:''' When LabVIEW launches it looks for lv_init.vi and invokes it.
* '''Description:''' When LabVIEW launches it looks for lv_init.vi and invokes it.
* '''Location:''' ./vi.lib/lv_init.vi
* '''Location:''' ./vi.lib/lv_init.vi
* '''Invoke Mechanism:''' Run Method
* '''Invoke Mechanism:''' Run Method
===lv_login.vi - LabVIEW Login Callback===
===lv_login.vi - LabVIEW Login Callback===
* '''Description:''' When a LabVIEW login is performed at startup
* '''Description:''' When a LabVIEW login is performed at startup
* '''Location:''' ./resource/plugins/lv_login.vi
* '''Location:''' ./resource/plugins/lv_login.vi
* '''Invoke Mechanisim:''' Call By Reference
* '''Invoke Mechanisim:''' Call By Reference
===lv_new.vi - "New" LabVIEW Object Callback===
===lv_new.vi - "New" LabVIEW Object Callback===
* '''Description:''' When File >> New is selected or the "New" button is selected from the main splash screen
* '''Description:''' When File >> New is selected or the "New" button is selected from the main splash screen
* '''Location:''' ./resource/plugins/lv_new.vi
* '''Location:''' ./resource/plugins/lv_new.vi
* '''Invoke Mechanisim:''' Call By Reference
* '''Invoke Mechanisim:''' Call By Reference
* '''Return Value:''' 0:OK; 1:Error-Use Classic New Dialog
* '''Return Value:''' 0:OK; 1:Error-Use Classic New Dialog
===lv_new_vi.vi - LabVIEW New VI Callback===
===lv_new_vi.vi - LabVIEW New VI Callback===
* '''Description:''' When File >> New VI <CTRL+N> is selected, LabVIEW will launch this VI, if present.
* '''Description:''' When File >> New VI <CTRL+N> is selected, LabVIEW will launch this VI, if present.
* '''Location:''' ./resource/plugins/lv_new_vi.vi
* '''Location:''' ./resource/plugins/lv_new_vi.vi
* '''Invoke Mechanisim:''' Call By Reference  Connector Pane I/O:
* '''Invoke Mechanisim:''' Call By Reference  Connector Pane I/O:
===lv_open.vi - LabVIEW Open Callback===
===lv_open.vi - LabVIEW Open Callback===
* '''Description:''' When File >> Open <CTRL+O> is selected, LabVIEW will launch this VI, if present.
* '''Description:''' When File >> Open <CTRL+O> is selected, LabVIEW will launch this VI, if present.
* '''Location:''' ./resource/plugins/lv_open.vi
* '''Location:''' ./resource/plugins/lv_open.vi
* '''Invoke Mechanisim:''' Call By Reference
* '''Invoke Mechanisim:''' Call By Reference


[[Category:IDE Add-ons]]
== NOTE: Required Connector Pane ==
All of these VIs, with the exception of the ''lv_init.vi'', require that the VI have the following [[Connector Pane]]:
 
[[File:IDE Event Callback VI Connector Pane.png|frame|none|Example Connector Pane Required]]
 
Input:
* '''input data''' - string (it is currently unknown what possible values show up here, maybe an exercise for someone to find out)
 
Output:
* '''return value''' - I32 numeric (some VIs have different actions depending on this output)
 
[[Category:Development Environment]]

Latest revision as of 06:42, 9 August 2024

Development Environment Callback VIs are VIs that LabVIEW looks for and attempts to run when certain development environment events occur. Most of these are installed as part of the Dataloging and Supervisory Control module (DSC) and are used for starting and stoping the DSC services that need to run along side LabVIEW. The lv_new.vi callback is used by LabVIEW to launch the "New" Dialog that includes a template browser.

The VIs

lv_about.vi - LabVIEW About Callback

  • Description: When Help >> About LabVIEW is selected, LabVIEW will launch this VI, if present.
  • Location: ./resource/plugins/lv_about.vi
  • Invoke Mechanism: Call By Reference

lv_exit.vi - LabVIEW Exiting Callback

  • Location: ./resource/plugins/lv_exit.vi
  • Invoke Mechanisim: Call By Reference
  • Return Value: 0:Don't Exit; 1:Exit

lv_init.vi - LabVIEW Initialization Callback

  • Description: When LabVIEW launches it looks for lv_init.vi and invokes it.
  • Location: ./vi.lib/lv_init.vi
  • Invoke Mechanism: Run Method

lv_login.vi - LabVIEW Login Callback

  • Description: When a LabVIEW login is performed at startup
  • Location: ./resource/plugins/lv_login.vi
  • Invoke Mechanisim: Call By Reference

lv_new.vi - "New" LabVIEW Object Callback

  • Description: When File >> New is selected or the "New" button is selected from the main splash screen
  • Location: ./resource/plugins/lv_new.vi
  • Invoke Mechanisim: Call By Reference
  • Return Value: 0:OK; 1:Error-Use Classic New Dialog

lv_new_vi.vi - LabVIEW New VI Callback

  • Description: When File >> New VI <CTRL+N> is selected, LabVIEW will launch this VI, if present.
  • Location: ./resource/plugins/lv_new_vi.vi
  • Invoke Mechanisim: Call By Reference Connector Pane I/O:

lv_open.vi - LabVIEW Open Callback

  • Description: When File >> Open <CTRL+O> is selected, LabVIEW will launch this VI, if present.
  • Location: ./resource/plugins/lv_open.vi
  • Invoke Mechanisim: Call By Reference

NOTE: Required Connector Pane

All of these VIs, with the exception of the lv_init.vi, require that the VI have the following Connector Pane:

Example Connector Pane Required

Input:

  • input data - string (it is currently unknown what possible values show up here, maybe an exercise for someone to find out)

Output:

  • return value - I32 numeric (some VIs have different actions depending on this output)