Jump to content

Template:VIServerGetPropertyLongName: Difference between revisions

From LabVIEW Wiki
Starting Templates
 
m Move documentation to subpage
 
Line 5,304: Line 5,304:
|E67CB803=
|E67CB803=
Value (Signaling)
Value (Signaling)
|unknown}}</includeonly><noinclude>
|unknown}}</includeonly><noinclude>{{documentation}}</noinclude>
 
== Usage ==
 
This template is a lookup table.  The input is the Property ID of a property of a class in the [[VI Server Class Hierarchy]].  It returns the Long Name in English, if found.  If not found, it returns a "unknown".  The Long Name is the displayed name in the drop down menus when selecting a property in a property node.
 
Syntax is as follows:
 
<code>
<nowiki>
{{VIServerGetPropertyLongName|{{{1}}}}}
</nowiki>
</code>
 
where:
 
{| class="wikitable"
! Parameter
! Description
! Default
|-
| <code>{{{1}}}</code>
| The Property ID of a property of a class in the [[VI Server Class Hierarchy]].
| <code></code>
|}
 
===Example===
0 is the Property ID for the [[Application class/Application.Name property|Application:Name property]] of [[Application class]].
 
<code>
<nowiki>
{{VIServerGetPropertyLongName|0}}
</nowiki>
</code>
 
===Result===
'''Result:''' {{VIServerGetPropertyLongName|0}}
 
===Example===
Passing a blank to the lookup won't be found and therefore returns "unknown".
 
<code>
<nowiki>
{{VIServerGetPropertyLongName|}}
</nowiki>
</code>
 
===Result===
'''Result:''' {{VIServerGetPropertyLongName|}}
 
== See Also ==
*[[Template:VIServerGetPropertyDataName]]
*[[Template:VIServerGetPropertyShortName]]
</noinclude>

Latest revision as of 16:56, 1 August 2024