Library class
| 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).
Contents |
Properties
Show/Hide Library Properties Table
| Legend | |
|---|---|
| R/W | Readable/Writable Permissions |
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Property ID | Long Name (English) | Description | R/W | RTE |
|---|---|---|---|---|
| 4D10E800 | Localized Name | The localized name of the item. | Read/Write | Yes (Read Only) |
| 4D10E801 | Version | The version number of the LabVIEW project library. | Read/Write | Yes (Read Only) |
| 4D10E802 | Description | Specifies the description of the LabVIEW project library for the Context Help window. | Read/Write | Yes (Read Only) |
| 4D10E803 | Locked | Read/Write | No | |
| 4D10E804 | Help:Document Tag | Index keyword or HTML filename for a topic in the compiled help file to which the LabVIEW project library is linked. | Read/Write | Yes (Read Only) |
| 4D10E805 | Help:Document 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. | Read/Write | Yes (Read Only) |
| 4D10E80C | DataLogging:Enable | Enables data logging capability if set to TRUE. | Read/Write | No |
| 4D10E80D | AlarmsEvents:Enable | Enables alarms and events logging capability if set to TRUE. | Read/Write | No |
| 4D10E80E | AlarmsEvents:Use DataLogging Database | 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. | Read/Write | No |
| 4D10E80F | AlarmsEvents:Database Name | Specifies the name of the database where the Shared Variable Engine logs alarms and events. | Read/Write | No |
| 4D10E810 | DataLogging:Database Path | Specifies the file path to the database where the Shared Variable Engine logs data. | Read/Write | No |
| 4D10E811 | AlarmsEvents:Database Path | Specifies the file path to the database where the Shared Variable Engine logs alarms and events. | Read/Write | No |
| 4D10E812 | AlarmsEvents:Database Computer | Specifies the name of the computer where the alarms and events database resides. | Read/Write | No |
| 4D10E813 | DataLogging:Database Name | Specifies the name of the database where the Shared Variable Engine logs data. | Read/Write | No |
| 4D10E814 | DataLogging:Database Computer | Specifies the name of the computer where the database resides. | Read/Write | No |
| 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. | Read/Write | No |
| 4D10E816 | Context:Has Edits In Another Context | Read Only | No | |
| 4D10E817 | Context: Has Edits In This Context | Read Only | No | |
| 4D10E818 | Context:Is Reserved In Other Context | Read Only | No | |
| 4D10E819 | Context:Is Reserved In This Context | Read Only | No | |
| 4D10E81A | Ignore Locks | Write Only | No | |
| 4D10E81B | Modifications Bit Set | Read Only | No | |
| 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. | Read/Write | Yes (Read Only) |
| 4D10E81D | Qualified Name | Returns the qualified name of the library. | Read Only | Yes (Read Only) |
| 4D10E81E | Amalgamation:Suppress Synchronize | Read/Write | Yes | |
| 4D10E81F | Signature | Returns an MD5 hash of the library. This value changes if the library changes. | Read Only | Yes |
| 4D10E820 | Process:Save State Period | The period (in minutes) the variable engine should save the process state. | Read/Write | No |
| 4D10E821 | Friends | Returns a list of strings which contain the qualified names of the friends of this library. | Read Only | Yes |
| 4D10E822 | Owning Application | Returns a reference to the application instance that owns this library. Be sure and close this reference afterward. | Read Only | Yes |
| 4D10E823 | Is In Packed Library | Returns TRUE if a packed project library contains the library. | Read Only | Yes |
| 4D10E824 | Packed Library:Source Project Path | Read Only | Yes | |
| 4D10E825 | Packed Library:GUID | Read Only | Yes | |
| 4D10E826 | Contains Compiled Code | Sets or returns whether LabVIEW stores the library in the compiled object cache. | Read/Write | No |
| 4D10E827 | Source Version | Read Only | No |
Methods
Show/Hide Library Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 4D10E400 | Source Scope:Set | Sets the access scope of an item that the LabVIEW project library owns, such as public or private access. | No |
| 4D10E401 | Source Scope:Get | Retrieves the access scope for an item that the LabVIEW project library owns, such as public or private access. | Yes (Read/Write) |
| 4D10E402 | Lock State:Set | Sets the level of editing permission for a LabVIEW project library, including the password. | No |
| 4D10E403 | Lock State:Get | Returns 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) |
| 4D10E404 | Library Tag:Get | Retrieves a tag set on the LabVIEW project library. | Yes (Read/Write) |
| 4D10E405 | Library Tag:Set | Sets a tag on the LabVIEW project library. | No |
| 4D10E406 | Library Tag:Delete | Deletes a tag from the LabVIEW project library. | No |
| 4D10E407 | Library Tag:Get Names | Retrieves a list of names for all tags set on the LabVIEW project library. | Yes (Read/Write) |
| 4D10E408 | Save:Library | 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. | No |
| 4D10E409 | Icon:Get | Retrieves the icon associated with a LabVIEW project library. | Yes (Read/Write) |
| 4D10E40A | Icon:Set | Sets the icon for a project library from image data you specify. | No |
| 4D10E40B | Debug Apply From Other Context | No | |
| 4D10E40C | Revert | No | |
| 4D10E40D | Synchronize In All Contexts | No | |
| 4D10E40E | Save:Copy | Saves a copy of the LabVIEW project library file. | No |
| 4D10E40F | Lock State:Set Temp Lock State | No | |
| 4D10E410 | Disconnect From Library | Disconnects a LabVIEW project library that is a sublibrary of another project library from the owning project library. | No |
| 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. | No |
| 4D10E412 | Library Data:Add | Yes | |
| 4D10E413 | Library Data:Get | Yes | |
| 4D10E414 | Save:Save to Buffer | Yes | |
| 4D10E415 | Set DocMod | No | |
| 4D10E416 | Apply Icon To Existing VI Items | 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. | No |
| 4D10E417 | Save:Target Library | No | |
| 4D10E418 | Amalgamation:Set Edits Only On This | Yes | |
| 4D10E419 | Hilite In Project Window | 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. | No |
| 4D10E41A | Amalgamation:ShouldDisposePieceOnNextSave | Yes | |
| 4D10E41B | Friends:Add Friend Library | Adds a friend to the list of friends of this library. | No |
| 4D10E41C | Friends:Add Friend VI | Adds a friend to the list of friends of this library. | No |
| 4D10E41D | Friends:Remove Friended VI or Library | Removes a friend from the list of friends of this library. | No |
| 4D10E41E | SetPath | No | |
| 4D10E41F | Set Path As Packed | No | |
| 4D10E420 | Disconnect Variables From Typedefs | Disconnects variables in the library from type definitions. | Yes (Read/Write) |
| 4D10E421 | Source Scope:Set 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. | No |
| 4D10E422 | Replace With A Packed Library | No | |
| 4D10E423 | License:Get License Status | Yes | |
| 4D10E424 | Packed Library:Get Non Exported Paths | No | |
| 4D10E425 | NI Security:Set Access Control List | Yes | |
| 4D10E426 | SaveBinary | Yes | |
| 4D10E427 | Save:Shifted Copy | No |
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) |
|---|---|
|
More info to come. |