Jump to content

Library class: Difference between revisions

From LabVIEW Wiki
Newer edit →
VisualWikitext
Started page
 
mNo edit summary
Line 1: Line 1:
{{VIServerClass|name=Library|id=80|scope=basic|class_0=ProjectItem|class_1=Library}}
{{VIServerClass|80}}


{{stub}}
{{stub}}
Line 511: Line 511:


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version

Revision as of 23:16, 1 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Library class
Class ID 80
Scope Basic Development Environment
Class Inheritance
Class Children


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

The Library class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Library Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Library Properties Table
Property ID Short Name (English) Description R/W RTE
4D10E812 AlarmsEvents.DBComputer Specifies the name of the computer where the alarms and events database resides.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E80F AlarmsEvents.DBName Specifies the name of the database where the Shared Variable Engine logs alarms and events.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E811 AlarmsEvents.DBPath Specifies the file path to the database where the Shared Variable Engine logs alarms and events.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E80D AlarmsEvents.Enable Enables alarms and events logging capability if set to TRUE.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E80E AlarmsEvents.UseDataLoggingDB Sets the alarms and events database to be the same as the database that logs data. If set to TRUE, LabVIEW ignores properties set on the AlarmsEvents database.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E81E Amalgamation.SuppressSynchronize R/W X
4D10E826 ContainsCompiledCode Sets or returns whether LabVIEW stores the library in the compiled object cache.

If TRUE, LabVIEW does not store the library in the compiled object cache. In this case, you must save the library every time you modify a member of the library or when you migrate the library to a new version of LabVIEW. If FALSE, LabVIEW stores the library in the compiled object cache so you must save the library only when you change the library itself.

This property is similar to the Separate compiled code from source file option on the General Settings page of the Project Library Properties dialog box.

R/W
4D10E817 HasEditsInThisContext R
4D10E816 HasEditsInAnotherContext R
4D10E818 IsReservedInOtherContext R
4D10E819 IsReservedInThisContext R
4D10E814 DataLogging.DBComputer Specifies the name of the computer where the database resides.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E813 DataLogging.DBName Specifies the name of the database where the Shared Variable Engine logs data.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E810 DataLogging.DBPath Specifies the file path to the database where the Shared Variable Engine logs data.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E80C DataLogging.Enable Enables data logging capability if set to TRUE.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E815 DataLogging.Lifespan Sets the lifespan (in days) of the logged data in the database. If value is 0, then data is always available, otherwise the database can destroy data after the number of specified days.

The database only discards data if new data is logged. This property affects all data from the library stored in the database, not just the most recent data. For example, if you set this property to four days and you have three days of data, the database does not destroy any data. However, if you set this same property to two days from four days and you have three days of data, the database can destroy any data collected more than two days ago.Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W
4D10E802 Description Specifies the description of the LabVIEW project library for the Context Help window.

If you want to display a carriage return in the Context Help window, you must separate paragraphs with two carriage returns.

This property is similar to the Description text box on the Documentation page of the Project Library Properties dialog box.Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W X
4D10E821 Friends Returns a list of strings which contain the qualified names of the friends of this library. R X
4D10E805 Help.Path Path or symbolic path to an HTML file (.htm or .html) or compiled help file (.chm or .hlp) to which the LabVIEW project library is linked.

If the path is to a compiled help file, use the Help:Document Tag property to determine the specific topic in that help file.

This property is similar to the Help path text box on the Documentation page of the Project Library Properties dialog box.Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W X
4D10E804 Help.Tag Index keyword or HTML filename for a topic in the compiled help file to which the LabVIEW project library is linked.

Use this property only when Help:Document Path is a path to a compiled help file (.chm or .hlp).

For .chm files, this property can be an HTML filename or index keyword. To link to a bookmark within an HTML file, add # followed by the name of the bookmark to the end of the filename. For .hlp files, this property can be an index keyword.

This property is similar to the Help tag text box on the Documentation page of the Project Library Properties dialog box.Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W X
4D10E81A IgnoreLocks W
4D10E823 IsInPackedLibrary Returns TRUE if a packed project library contains the library. R X
4D10E800 LocalizedName The localized name of the item.

This property is similar to the Localized Name text box on the Documentation page of the Project Library Properties dialog box.Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W X
4D10E803 Locked R/W
4D10E81B Mods R
4D10E81C Name Returns the name of the library. If the library has not been saved to disk, you can write to this property to change the name.

Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W X
4D10E822 OwningApp Returns a reference to the application instance that owns this library. Be sure and close this reference afterward. R X
4D10E825 Packed Library.GUID R X
4D10E824 Packed Library.SourceProjPath R X
4D10E820 Process.SaveStatePeriod The period (in minutes) the variable engine should save the process state. R/W
4D10E81D QualifiedName Returns the qualified name of the library. R X
4D10E81F Signature Returns an MD5 hash of the library. This value changes if the library changes. R X
4D10E827 SourceVersion R
4D10E801 Version The version number of the LabVIEW project library.

This property is similar to the Version Number component on the General Settings page of the Project Library Properties dialog box.Note The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.

R/W X

Methods

Show/Hide Library Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Library Methods Table
Method ID Short Name (English) Description RTE
4D10E418 Amalgamation.SetEditsOnlyOnThis X
4D10E41A Amalgamation.ShouldDisposePieceOnNextSave X
4D10E416 ApplyIconToVIs Applies the icon for a library to the icons of all objects in the library. You can use this method to update the icons for objects in a library after you edit the library icon. This method loads member objects of the library into memory if they are not already in memory. Callers might be prompted to provide VI passwords or to save the loaded VIs.
4D10E40B Debug Apply From Other Context
4D10E410 DisconnectFromLibrary Disconnects a LabVIEW project library that is a sublibrary of another project library from the owning project library.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

4D10E420 DisconnectVariablesFromTypedefs Disconnects variables in the library from type definitions. X
4D10E41B AddFriendLibrary Adds a friend to the list of friends of this library.
4D10E41C AddFriendVI Adds a friend to the list of friends of this library.
4D10E41D RemoveFriend Removes a friend from the list of friends of this library.
4D10E419 HiliteInProjectWindow Shows this library in a project window. If the library is already in a project window, this will show the project window and set focus to the library item in the project. If the library is already in a library-only project window for which it is the root item, this will show the library-only project window. If the library is not in any project window, this will open a library-only project window containing the library.
4D10E409 Get Icon Retrieves the icon associated with a LabVIEW project library.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

X
4D10E40A Set Icon Sets the icon for a project library from image data you specify.

LabVIEW applies a library icon to the icon of all objects in the library. National Instruments recommends creating only a banner for the library icon. The icon for each object in the library then includes the banner, and you can modify the body of the icon to provide information about the specific object.

4D10E412 LibraryData.Add X
4D10E413 LibraryData.Get X
4D10E406 Delete Lib Tag Deletes a tag from the LabVIEW project library.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

4D10E404 Get Lib Tag Retrieves a tag set on the LabVIEW project library.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

X
4D10E407 Get Lib Tag Names Retrieves a list of names for all tags set on the LabVIEW project library.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

X
4D10E405 Set Lib Tag Sets a tag on the LabVIEW project library.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

4D10E423 License.Get License Status X
4D10E403 Get Lock State Returns the lock state of the LabVIEW project library and indicates whether the password for the project library is in the password cache.

This method is similar to the Protection page of the Project Library Properties dialog box.

X
4D10E402 Set Lock State Sets the level of editing permission for a LabVIEW project library, including the password.

This method is similar to the Protection page of the Project Library Properties dialog box.

4D10E40F Set Temp Lock State
4D10E425 NI Sec.Set ACL X
4D10E424 Packed Library.GetNonExportedPaths
4D10E40C Revert
4D10E40E Save a Copy Saves a copy of the LabVIEW project library file.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

4D10E411 Save For Previous Saves a copy of the project library and all items within the project library that is readable by LabVIEW 8.0 and later. This method is similar to the LabVIEW Version selection on the Save for Previous Version dialog box.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

4D10E408 Save Saves the LabVIEW project library file. You also can right-click the project library in the Project Explorer window and select Save As from the shortcut menu to save the project library file.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

4D10E414 Save to buffer X
4D10E427 Save a Shifted Copy
4D10E417 Save.Target Library
4D10E426 SaveBinary X
4D10E415 Set DocMod
4D10E41F SetPathAsPacked
4D10E41E SetPath
4D10E401 Get Source Scope Retrieves the access scope for an item that the LabVIEW project library owns, such as public or private access.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

X
4D10E400 Set Source Scope Sets the access scope of an item that the LabVIEW project library owns, such as public or private access.

This method is similar to the Access Scope box on the Item Settings page of the Project Library Properties dialog box.

Note The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

4D10E421 Set Source Scope And Propagate Sets the access scope of an item that the LabVIEW project library owns, such as public or private access. If the item is a dynamic dispatch VI, LabVIEW also changes the scope of other implementations.
4D10E40D Synchronize In All Contexts

Events

No Events for this class.

History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=Library_class&oldid=9259"