Jump to content

Template:VIServerPropsTable

From LabVIEW Wiki
Revision as of 16:23, 6 September 2019 by Q (talk | contribs) (Editing Template to be the properties lookup table.)


Usage

This template contains a lookup table for all of the properties It is used in the VI Server Class Hierarchy class pages. The parameter is either the Class ID number where the list is then filtered to properties of that class, or the parameter is left blank to signify this class has no properties.

Parameter Description Default
{{{1}}} The class ID. Blank - Translates into message: No Properties for this class.

Example: No Properties Exists

{{VIServerPropsTable}}

No Properties for this class.


Example: Properties Exist - Application Class

{{VIServerPropsTable|1}}


Show/Hide Application Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Application Properties Table
Property ID Long Name (English) Description R/W RTE
0Application:NameFilename of the application.RX
1Application:User NameUser name used to open the application.R/WX
2Application:VersionVersion number of the application. In a stand-alone application or shared library, this property returns the version of the LabVIEW Run-Time Engine.RX
3Application:KindIndicates the LabVIEW instance the VI is running in, including invalid application types.RX
4Application:Target:Operating SystemIndicates the operating system for which the application was built.RX
5Application:Target:CPUIndicates the target CPU of an application.RX
6Operating System:NameName of the operating system where the application is actually running.RX



Example: Properties Exist - VI Class

{{VIServerPropsTable|2}}


Show/Hide VI Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
VI Properties Table
Property ID Long Name (English) Description R/W RTE
1F4VI NameName of the VI file. If a LabVIEW project library owns the VI, the property returns the qualified name of the VI, which includes the project library filename.R/WX
1F5VI PathPath to the VI file.RX
1F6VI DescriptionDescription of the VI that appears in the Context Help window when you move the cursor over the VI icon and in VI documentation you generate.R/WX



Example: Properties Exist - Generic Class

{{VIServerPropsTable|3}}


Show/Hide Generic Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Generic Properties Table
Property ID Long Name (English) Description R/W RTE
6327800Class IDClass identifier of the object.RX
6327801Owner (Deprecated)Reference to the owning object.RX
6327802Owning VIReturns a reference to the VI that owns this object.RX
6327803Class NameName of the VI Server class that contains the object.RX
6327804Modified Property pages use this for generic get/set of properties.RX
6327805Is On Block Diagram?Returns TRUE when the object is located on the block diagram.RX
6327806OwnerReference to the owning object.RX