Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Commit Shared Variables VI

Owning Palette: Variables & I/O Servers VIs

Installed With: DSC Module

Commits multiple shared variables to the Shared Variable Engine simultaneously.

Details  

shared variables specifies the array of shared variables you want to commit.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
shared variables out returns the URLs to the shared variables you committed. The URLs are in the following format: \\machine name\process\shared_variable.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Commit Shared Variables Details

Use this VI to simultaneously commit multiple buffered shared variables that you create or modify. First you must buffer the shared variables to hold them in memory temporarily. If you create a new shared variable, set the set mode input of the Create Shared Variable VI to buffer. If you modify an existing shared variable, set the Property Set Mode property of the SharedVariableIO class to buffer before making property changes. Wire an array of the shared variable references you created or modified to the shared variables input of the Commit Shared Variables VI. Committing multiple shared variable references simultaneously has better performance than updating shared variable properties one at a time.


Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit