You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.5 Help

Returns a reference to a VI Server application running on the specified computer.

If you specify an empty string for machine name, it returns a reference to the local LabVIEW application in which this function is running. If you do specify a machine name, it attempts to establish a TCP connection with a remote VI Server on that machine on the specified port.

Details  

	machine name is the address of the computer that runs an application instance to which you want to establish a connection. This address can be in dotted decimal notation (such as 130.164.15.250) or domain name notation (such as foo.ni.com). An empty string causes this function to return a reference to the local application instance.
	port number or service name can accept a numeric or a string input. The default is a numeric. port number or service name is the port on which the remote LabVIEW application is listening. If you specify a service name, LabVIEW queries the NI Service Locator for the port number that the server registered. The default is to use the default VI Server listener port number (3363). To establish communication between a VI and another LabVIEW application, you must know both the machine name and the port number or service name on which the VI Server in the other LabVIEW application is listening. If you have more than one LabVIEW application on the same machine, one or more of those applications may be listening on a port other than the default VI Server listener port. In this case, make sure to supply the port number or service name. Use the VI Server: Configuration Options page to set the port number and service name for a VI Server or use the Server:Port and Server:Service Name properties to set the port number or service name programmatically. Note  The VI Server settings in the Options dialog box apply to the default application instance, or VIs not in a project. To set VI Server settings for a project application instance, right-click the target in the Project Explorer window.
	timeout ms is the period of time in milliseconds to wait before the function completes and returns an error. The default value is 60,000 ms or 1 minute. A value of –1 indicates to wait indefinitely.
	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.
	application reference is the reference to the specified application.
	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.

Open Application Reference Details

You can use the application reference output as an input to the Property and Invoke Nodes to get or set properties and invoke methods on the application. Using it as the input to the Open VI Reference function lets you get references to VIs in that application. Close the reference with the Close Reference function. If you do not close this reference, it closes automatically after the top-level VI associated with this function completes execution. However, it is good practice to conserve the resources involved in maintaining the connection by closing the reference when you finish using it.

If you use the Open Application Reference function on a remote VI Server connection, you may receive an error that the network connection was closed by a peer. Verify that the machine is allowed access by selecting Tools»Options»VI Server: Machine Access on the server side. You also can verify the user access settings on the VI Server: User Access options page on the server side, also located in the Options dialog box.