Jump to content

Template:VIServerGetPropertyShortName: Difference between revisions

From LabVIEW Wiki
Starting Templates
 
m Move documentation to subpage
 
Line 5,304: Line 5,304:
|E67CB803=
|E67CB803=
Val(Sgnl)
Val(Sgnl)
|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 Short Name in English, if found.  If not found, it returns a "unknown".
 
Syntax is as follows:
 
<code>
<nowiki>
{{VIServerGetPropertyShortName|{{{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===
632A813 is the Property ID for the [[GObject class/UID property|UID property]] of [[GObject class]].
 
<code>
<nowiki>
{{VIServerGetPropertyShortName|632A813}}
</nowiki>
</code>
 
===Result===
Result: ({{VIServerGetPropertyShortName|632A813}})
 
===Example===
Passing a blank to the lookup won't be found and therefore returns "unknown".
 
<code>
<nowiki>
{{VIServerGetPropertyShortName|}}
</nowiki>
</code>
 
===Result===
Result: ({{VIServerGetPropertyShortName|}})
 
== See Also ==
*[[Template:VIServerGetPropertyDataName]]
*[[Template:VIServerGetPropertyLongName]]
</noinclude>

Latest revision as of 16:57, 1 August 2024