Jump to content

Library class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
m Removed VI Server Category from page
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide Library Properties Table</span>
{{VIServerClassTables|80}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Library Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|4D10E812
| [[Library class/AlarmsEvents.DBComputer property|AlarmsEvents.DBComputer]]
|Specifies the name of the computer where the alarms and events database resides.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E80F
| [[Library class/AlarmsEvents.DBName property|AlarmsEvents.DBName]]
|Specifies the name of the database where the Shared Variable Engine logs alarms and events.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E811
| [[Library class/AlarmsEvents.DBPath property|AlarmsEvents.DBPath]]
|Specifies the file path to the database where the Shared Variable Engine logs alarms and events.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E80D
| [[Library class/AlarmsEvents.Enable property|AlarmsEvents.Enable]]
|Enables alarms and events logging capability if set to TRUE.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E80E
| [[Library class/AlarmsEvents.UseDataLoggingDB property|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.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#D1BB80;"
|4D10E81E
| [[Library class/Amalgamation.SuppressSynchronize property|Amalgamation.SuppressSynchronize]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|4D10E826
| [[Library class/ContainsCompiledCode property|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 <b>Separate compiled code from source file</b> option on the General Settings page of the Project Library Properties dialog box.
|R/W
|
|- style="background-color:#D1BB80;"
|4D10E817
| [[Library class/HasEditsInThisContext property|HasEditsInThisContext]]
|
|R
|
|- style="background-color:#D1BB80;"
|4D10E816
| [[Library class/HasEditsInAnotherContext property|HasEditsInAnotherContext]]
|
|R
|
|- style="background-color:#D1BB80;"
|4D10E818
| [[Library class/IsReservedInOtherContext property|IsReservedInOtherContext]]
|
|R
|
|- style="background-color:#D1BB80;"
|4D10E819
| [[Library class/IsReservedInThisContext property|IsReservedInThisContext]]
|
|R
|
|- style="background-color:#FFFFCC;"
|4D10E814
| [[Library class/DataLogging.DBComputer property|DataLogging.DBComputer]]
|Specifies the name of the computer where the database resides.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E813
| [[Library class/DataLogging.DBName property|DataLogging.DBName]]
|Specifies the name of the database where the Shared Variable Engine logs data.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E810
| [[Library class/DataLogging.DBPath property|DataLogging.DBPath]]
|Specifies the file path to the database where the Shared Variable Engine logs data.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E80C
| [[Library class/DataLogging.Enable property|DataLogging.Enable]]
|Enables data logging capability if set to TRUE.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E815
| [[Library class/DataLogging.Lifespan property|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.<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E802
| [[Library class/Description property|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 <b>Description</b> text box on the Documentation page of the Project Library Properties dialog box.<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|X
|- style="background-color:#FFFFCC;"
|4D10E821
| [[Library class/Friends property|Friends]]
|Returns a list of strings which contain the qualified names of the friends of this library.
|R
|X
|- style="background-color:#FFFFCC;"
|4D10E805
| [[Library class/Help.Path property|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 <b>Help path</b> text box on the Documentation page of the Project Library Properties dialog box.<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|X
|- style="background-color:#FFFFCC;"
|4D10E804
| [[Library class/Help.Tag property|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 <b>Help tag</b> text box on the Documentation page of the Project Library Properties dialog box.<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|X
|- style="background-color:#D1BB80;"
|4D10E81A
| [[Library class/IgnoreLocks property|IgnoreLocks]]
|
|W
|
|- style="background-color:#FFFFCC;"
|4D10E823
| [[Library class/IsInPackedLibrary property|IsInPackedLibrary]]
|Returns TRUE if a packed project library contains the library.
|R
|X
|- style="background-color:#FFFFCC;"
|4D10E800
| [[Library class/LocalizedName property|LocalizedName]]
|The localized name of the item.
 
This property is similar to the <b>Localized Name</b> text box on the Documentation page of the Project Library Properties dialog box.<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|X
|- style="background-color:#D1BB80;"
|4D10E803
| [[Library class/Locked property|Locked]]
|
|R/W
|
|- style="background-color:#D1BB80;"
|4D10E81B
| [[Library class/Mods property|Mods]]
|
|R
|
|- style="background-color:#FFFFCC;"
|4D10E81C
| [[Library class/Name property|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.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|X
|- style="background-color:#FFFFCC;"
|4D10E822
| [[Library class/OwningApp property|OwningApp]]
|Returns a reference to the application instance that owns this library.  Be sure and close this reference afterward.
|R
|X
|- style="background-color:#D1BB80;"
|4D10E825
| [[Library class/Packed Library.GUID property|Packed Library.GUID]]
|
|R
|X
|- style="background-color:#D1BB80;"
|4D10E824
| [[Library class/Packed Library.SourceProjPath property|Packed Library.SourceProjPath]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|4D10E820
| [[Library class/Process.SaveStatePeriod property|Process.SaveStatePeriod]]
|The period (in minutes) the variable engine should save the process state.
|R/W
|
|- style="background-color:#FFFFCC;"
|4D10E81D
| [[Library class/QualifiedName property|QualifiedName]]
|Returns the qualified name of the library.
|R
|X
|- style="background-color:#CCFFFF;"
|4D10E81F
| [[Library class/Signature property|Signature]]
|Returns an MD5 hash of the library. This value changes if the library changes.
|R
|X
|- style="background-color:#D1BB80;"
|4D10E827
| [[Library class/SourceVersion property|SourceVersion]]
|
|R
|
|- style="background-color:#FFFFCC;"
|4D10E801
| [[Library class/Version property|Version]]
|The version number of the LabVIEW project library.
 
This property is similar to the <b>Version Number</b> component on the General Settings page of the Project Library Properties dialog box.<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this property in the Run-Time Engine.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Library Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Library Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#D1BB80;"
|4D10E418
| [[Library class/Amalgamation.SetEditsOnlyOnThis method|Amalgamation.SetEditsOnlyOnThis]]
|
|X
|- style="background-color:#D1BB80;"
|4D10E41A
| [[Library class/Amalgamation.ShouldDisposePieceOnNextSave method|Amalgamation.ShouldDisposePieceOnNextSave]]
|
|X
|- style="background-color:#FFFFCC;"
|4D10E416
| [[Library class/ApplyIconToVIs method|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.
|
|- style="background-color:#D1BB80;"
|4D10E40B
| [[Library class/Debug Apply From Other Context method|Debug Apply From Other Context]]
|
|
|- style="background-color:#FFFFCC;"
|4D10E410
| [[Library class/DisconnectFromLibrary method|DisconnectFromLibrary]]
|Disconnects a LabVIEW project library that is a sublibrary of another project library from the owning project library.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|
|- style="background-color:#FFFFCC;"
|4D10E420
| [[Library class/DisconnectVariablesFromTypedefs method|DisconnectVariablesFromTypedefs]]
|Disconnects variables in the library from type definitions.
|X
|- style="background-color:#FFFFCC;"
|4D10E41B
| [[Library class/AddFriendLibrary method|AddFriendLibrary]]
|Adds a friend to the list of friends of this library.
|
|- style="background-color:#FFFFCC;"
|4D10E41C
| [[Library class/AddFriendVI method|AddFriendVI]]
|Adds a friend to the list of friends of this library.
|
|- style="background-color:#FFFFCC;"
|4D10E41D
| [[Library class/RemoveFriend method|RemoveFriend]]
|Removes a friend from the list of friends of this library.
|
|- style="background-color:#FFFFCC;"
|4D10E419
| [[Library class/HiliteInProjectWindow method|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.
|
|- style="background-color:#FFFFCC;"
|4D10E409
| [[Library class/Get Icon method|Get Icon]]
|Retrieves the icon associated with a LabVIEW project library.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|X
|- style="background-color:#FFFFCC;"
|4D10E40A
| [[Library class/Set Icon method|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.
|
|- style="background-color:#D1BB80;"
|4D10E412
| [[Library class/LibraryData.Add method|LibraryData.Add]]
|
|X
|- style="background-color:#D1BB80;"
|4D10E413
| [[Library class/LibraryData.Get method|LibraryData.Get]]
|
|X
|- style="background-color:#FFFFCC;"
|4D10E406
| [[Library class/Delete Lib Tag method|Delete Lib Tag]]
|Deletes a tag from the LabVIEW project library.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|
|- style="background-color:#FFFFCC;"
|4D10E404
| [[Library class/Get Lib Tag method|Get Lib Tag]]
|Retrieves a tag set on the LabVIEW project library.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|X
|- style="background-color:#FFFFCC;"
|4D10E407
| [[Library class/Get Lib Tag Names method|Get Lib Tag Names]]
|Retrieves a list of names for all tags set on the LabVIEW project library.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|X
|- style="background-color:#FFFFCC;"
|4D10E405
| [[Library class/Set Lib Tag method|Set Lib Tag]]
|Sets a tag on the LabVIEW project library.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|
|- style="background-color:#D1BB80;"
|4D10E423
| [[Library class/License.Get License Status method|License.Get License Status]]
|
|X
|- style="background-color:#FFFFCC;"
|4D10E403
| [[Library class/Get Lock State method|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
|- style="background-color:#FFFFCC;"
|4D10E402
| [[Library class/Set Lock State method|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.
|
|- style="background-color:#D1BB80;"
|4D10E40F
| [[Library class/Set Temp Lock State method|Set Temp Lock State]]
|
|
|- style="background-color:#D1BB80;"
|4D10E425
| [[Library class/NI Sec.Set ACL method|NI Sec.Set ACL]]
|
|X
|- style="background-color:#D1BB80;"
|4D10E424
| [[Library class/Packed Library.GetNonExportedPaths method|Packed Library.GetNonExportedPaths]]
|
|
|- style="background-color:#D1BB80;"
|4D10E40C
| [[Library class/Revert method|Revert]]
|
|
|- style="background-color:#FFFFCC;"
|4D10E40E
| [[Library class/Save a Copy method|Save a Copy]]
|Saves a copy of the LabVIEW project library file.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|
|- style="background-color:#FFFFCC;"
|4D10E411
| [[Library class/Save For Previous method|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 <b>LabVIEW Version</b> selection on the Save for Previous Version dialog box.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|
|- style="background-color:#FFFFCC;"
|4D10E408
| [[Library class/Save method|Save]]
|Saves the LabVIEW project library file. You also can right-click the project library in the Project Explorer window and select <b>Save As</b> from the shortcut menu to save the project library file.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|
|- style="background-color:#D1BB80;"
|4D10E414
| [[Library class/Save to buffer method|Save to buffer]]
|
|X
|- style="background-color:#D1BB80;"
|4D10E427
| [[Library class/Save a Shifted Copy method|Save a Shifted Copy]]
|
|
|- style="background-color:#D1BB80;"
|4D10E417
| [[Library class/Save.Target Library method|Save.Target Library]]
|
|
|- style="background-color:#D1BB80;"
|4D10E426
| [[Library class/SaveBinary method|SaveBinary]]
|
|X
|- style="background-color:#D1BB80;"
|4D10E415
| [[Library class/Set DocMod method|Set DocMod]]
|
|
|- style="background-color:#D1BB80;"
|4D10E41F
| [[Library class/SetPathAsPacked method|SetPathAsPacked]]
|
|
|- style="background-color:#D1BB80;"
|4D10E41E
| [[Library class/SetPath method|SetPath]]
|
|
|- style="background-color:#FFFFCC;"
|4D10E401
| [[Library class/Get Source Scope method|Get Source Scope]]
|Retrieves the access scope for an item that the LabVIEW project library owns, such as public or private access.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|X
|- style="background-color:#FFFFCC;"
|4D10E400
| [[Library class/Set Source Scope method|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.
 
<b>Note</b>  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.
|
|- style="background-color:#FFFFCC;"
|4D10E421
| [[Library class/Set Source Scope And Propagate method|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.
|
|- style="background-color:#D1BB80;"
|4D10E40D
| [[Library class/Synchronize In All Contexts method|Synchronize In All Contexts]]
|
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 525: Line 25:
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 01:57, 8 May 2020

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 Long Name (English) Description R/W RTE
4D10E800Localized NameThe localized name of the item.Read/WriteYes (Read Only)
4D10E801VersionThe version number of the LabVIEW project library.Read/WriteYes (Read Only)
4D10E802DescriptionSpecifies the description of the LabVIEW project library for the Context Help window.Read/WriteYes (Read Only)
4D10E803LockedRead/WriteNo
4D10E804Help:Document TagIndex keyword or HTML filename for a topic in the compiled help file to which the LabVIEW project library is linked.Read/WriteYes (Read Only)
4D10E805Help:Document PathPath 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.Read/WriteYes (Read Only)
4D10E80CDataLogging:EnableEnables data logging capability if set to TRUE.Read/WriteNo
4D10E80DAlarmsEvents:EnableEnables alarms and events logging capability if set to TRUE.Read/WriteNo
4D10E80EAlarmsEvents:Use DataLogging DatabaseSets 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.Read/WriteNo
4D10E80FAlarmsEvents:Database NameSpecifies the name of the database where the Shared Variable Engine logs alarms and events.Read/WriteNo
4D10E810DataLogging:Database PathSpecifies the file path to the database where the Shared Variable Engine logs data.Read/WriteNo
4D10E811AlarmsEvents:Database PathSpecifies the file path to the database where the Shared Variable Engine logs alarms and events.Read/WriteNo
4D10E812AlarmsEvents:Database ComputerSpecifies the name of the computer where the alarms and events database resides.Read/WriteNo
4D10E813DataLogging:Database NameSpecifies the name of the database where the Shared Variable Engine logs data.Read/WriteNo
4D10E814DataLogging:Database ComputerSpecifies the name of the computer where the database resides.Read/WriteNo
4D10E815DataLogging:LifespanSets 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.Read/WriteNo
4D10E816Context:Has Edits In Another ContextRead OnlyNo
4D10E817Context: Has Edits In This ContextRead OnlyNo
4D10E818Context:Is Reserved In Other ContextRead OnlyNo
4D10E819Context:Is Reserved In This ContextRead OnlyNo
4D10E81AIgnore LocksWrite OnlyNo
4D10E81BModifications Bit SetRead OnlyNo
4D10E81CNameReturns the name of the library. If the library has not been saved to disk, you can write to this property to change the name.Read/WriteYes (Read Only)
4D10E81DQualified NameReturns the qualified name of the library.Read OnlyYes (Read Only)
4D10E81EAmalgamation:Suppress SynchronizeRead/WriteYes
4D10E81FSignatureReturns an MD5 hash of the library. This value changes if the library changes.Read OnlyYes
4D10E820Process:Save State PeriodThe period (in minutes) the variable engine should save the process state.Read/WriteNo
4D10E821FriendsReturns a list of strings which contain the qualified names of the friends of this library.Read OnlyYes
4D10E822Owning ApplicationReturns a reference to the application instance that owns this library. Be sure and close this reference afterward.Read OnlyYes
4D10E823Is In Packed LibraryReturns TRUE if a packed project library contains the library.Read OnlyYes
4D10E824Packed Library:Source Project PathRead OnlyYes
4D10E825Packed Library:GUIDRead OnlyYes
4D10E826Contains Compiled CodeSets or returns whether LabVIEW stores the library in the compiled object cache.Read/WriteNo
4D10E827Source VersionRead OnlyNo

Methods

Show/Hide Library Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Library Methods Table
Method ID Long Name (English) Description RTE
4D10E400Source Scope:SetSets the access scope of an item that the LabVIEW project library owns, such as public or private access.No
4D10E401Source Scope:GetRetrieves the access scope for an item that the LabVIEW project library owns, such as public or private access.Yes (Read/Write)
4D10E402Lock State:SetSets the level of editing permission for a LabVIEW project library, including the password.No
4D10E403Lock State:GetReturns the lock state of the LabVIEW project library and indicates whether the password for the project library is in the password cache.Yes (Read/Write)
4D10E404Library Tag:GetRetrieves a tag set on the LabVIEW project library.Yes (Read/Write)
4D10E405Library Tag:SetSets a tag on the LabVIEW project library.No
4D10E406Library Tag:DeleteDeletes a tag from the LabVIEW project library.No
4D10E407Library Tag:Get NamesRetrieves a list of names for all tags set on the LabVIEW project library.Yes (Read/Write)
4D10E408Save:LibrarySaves 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.No
4D10E409Icon:GetRetrieves the icon associated with a LabVIEW project library.Yes (Read/Write)
4D10E40AIcon:SetSets the icon for a project library from image data you specify.No
4D10E40BDebug Apply From Other ContextNo
4D10E40CRevertNo
4D10E40DSynchronize In All ContextsNo
4D10E40ESave:CopySaves a copy of the LabVIEW project library file.No
4D10E40FLock State:Set Temp Lock StateNo
4D10E410Disconnect From LibraryDisconnects a LabVIEW project library that is a sublibrary of another project library from the owning project library.No
4D10E411Save:For PreviousSaves 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.No
4D10E412Library Data:AddYes
4D10E413Library Data:GetYes
4D10E414Save:Save to BufferYes
4D10E415Set DocModNo
4D10E416Apply Icon To Existing VI ItemsApplies 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.No
4D10E417Save:Target LibraryNo
4D10E418Amalgamation:Set Edits Only On ThisYes
4D10E419Hilite In Project WindowShows 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.No
4D10E41AAmalgamation:ShouldDisposePieceOnNextSaveYes
4D10E41BFriends:Add Friend LibraryAdds a friend to the list of friends of this library.No
4D10E41CFriends:Add Friend VIAdds a friend to the list of friends of this library.No
4D10E41DFriends:Remove Friended VI or LibraryRemoves a friend from the list of friends of this library.No
4D10E41ESetPathNo
4D10E41FSet Path As PackedNo
4D10E420Disconnect Variables From TypedefsDisconnects variables in the library from type definitions.Yes (Read/Write)
4D10E421Source Scope:Set and PropagateSets 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.No
4D10E422Replace With A Packed LibraryNo
4D10E423License:Get License StatusYes
4D10E424Packed Library:Get Non Exported PathsNo
4D10E425NI Security:Set Access Control ListYes
4D10E426SaveBinaryYes
4D10E427Save:Shifted CopyNo

Events

This class has no events or it inherits events from its parent: ProjectItem 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=26612"