Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Get License Status VI

LabVIEW 2012 Third Party Licensing & Activation Toolkit Help

Edition Date: June 2012

Part Number: 373159C-01

»View Product Info
Download Help (Windows Only)

Owning Palette: Third Party Licensing & Activation VIs

Requires: Third Party Licensing & Activation Toolkit

Returns the status of a license file. Use this VI to check if a license file associated with an add-on is activated, in evaluation mode, expired, or invalid.

Details  Example

license file info contains information that identifies the run-time license that protects the add-on when users run the add-on.
handle is a reference to the license file and is used internally only. You do not need to change this input.
full path specifies the full, or absolute, path to the license file on the user machine.
password specifies the password for the license file.
dev license is valid specifies whether a user with a development license can use that license instead of using the run-time license the license file info input identifies. The default is FALSE. If TRUE, this VI checks the status of both the run-time license and the development license, which you identify with the dev license file info input.
Distributing both development and run-time licenses is useful for allowing you to protect certain functionality with the run-time license, but still allowing users to test parts of the product in a development environment.
dev license file info contains information that identifies a development license file that can optionally protect the add-on. If the dev license is valid input is FALSE, LabVIEW ignores this input and checks only the run-time license, which you identify with the license file info input.

If dev license is valid is TRUE, LabVIEW uses this development license only if the status of the development license is "better" than the status of the run-time license. For example, if the run-time license is expired, but the development license is activated or in evaluation status, then the development license can allow users to access the add-on.
Note  This development license file must be present in the following directory: [Public App Data]\National Instruments\Partners\company name\Licenses, where [Public App Data] corresponds to the CommonAppDataFolder property and company name is the same value you specified when you licensed the add-on.
name specifies the name of the development license file.
password specifies the password for the license file.
company name is the name you supplied when you associated the license file with the add-on library. LabVIEW uses company name to locate the directory that contains the add-on license on the user computer because add-on licenses are installed into a directory named after the company.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
custom hardware ID specifies the serial number of the hardware target with which you want to use the license. If the license file is bound to the serial number for a specific target, the custom hardware ID must match the number in the license. Otherwise, this VI returns a license status of Invalid, even if the license has a status of activated or evaluation.

If you do not wire a value to this input, this VI does not check the license for a serial number.
license file info out returns information about the run-time license from the license file info input.
handle returns the reference that is used internally only.
full path returns the full, or absolute, path to the license file that the user wants to activate.
password returns the password to the license file that the user wants to activate.
license status returns the status of the license that LabVIEW uses to activate the add-on. You define the meaning of each status when you create the license file.

This VI returns the status of the license the license file info input identifies unless dev license is valid is TRUE. In this case, LabVIEW returns the status of either license file info or dev license file info, depending on which license has the "best" status. For example, if the run-time license is expired, but the development license is activated or in evaluation status, then this VI returns the status of the development license.

0Invalid
1Expired
2Evaluation
3Activated
error code returns an error if this VI fails to retrieve the license status. This error code is from SoftwareKey. Visit the support section of the SoftwareKey website for more information about this error code.
error out contains error information. This output provides standard error out functionality.

Get License Status Details




 Third Party Licensing & Activation Toolkit Home

Example

Refer to the Get License Status VI in the labview\examples\addonlicensing\01 Get License Status directory for an example of using the Get License Status VI.


 

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