Jump to content

Template:VIServerProperty: Difference between revisions

From LabVIEW Wiki
mNo edit summary
mNo edit summary
Line 3: Line 3:
|-  
|-  
! scope="row" style="text-align:left;" | Property ID
! scope="row" style="text-align:left;" | Property ID
| {{{2}}}
| {{{propertyid}}}
|- {{#switch: {{{scope}}} | basic = style="background-color:#FFFFCC;" | script = style="background-color:#CCFFFF;" | private = style="background-color:#D1BB80;" | deprecated = style="background-color:#FFAAAA;" }}
|- {{#switch: {{{scope}}} | basic = style="background-color:#FFFFCC;" | script = style="background-color:#CCFFFF;" | private = style="background-color:#D1BB80;" | deprecated = style="background-color:#FFAAAA;" }}
! scope="row" {{#switch: {{{scope}}} | basic = style="background-color:#FFFFCC; | script = style="background-color:#CCFFFF; | private = style="background-color:#D1BB80; | deprecated = style="background-color:#FFAAAA; }}text-align:left;" | Scope
! scope="row" {{#switch: {{{scope}}} | basic = style="background-color:#FFFFCC; | script = style="background-color:#CCFFFF; | private = style="background-color:#D1BB80; | deprecated = style="background-color:#FFAAAA; }}text-align:left;" | Scope
Line 9: Line 9:
|-
|-
! scope="row" style="text-align:left;" | Data Name
! scope="row" style="text-align:left;" | Data Name
| {{VIServerGetPropertyDataName|{{{2}}}}}
| {{{dataname}}}
|-  
|-  
! scope="row" style="text-align:left;" | Short Name<sup>*</sup>
! scope="row" style="text-align:left;" | Short Name<sup>*</sup>
| {{VIServerGetPropertyShortName|{{{2}}}}}
| {{{shortname}}}
|-
|-
! scope="row" style="text-align:left;" | Long Name<sup>*</sup>
! scope="row" style="text-align:left;" | Long Name<sup>*</sup>
| {{VIServerGetPropertyLongName|{{{2}}}}}
| {{{longname}}}
|-
|-
| colspan="2" style="text-align:left; font-size: 0.75em;" |* Displayed here in English.  Short and Long names appear in the language of the LabVIEW IDE.
| colspan="2" style="text-align:left; font-size: 0.75em;" |* Displayed here in English.  Short and Long names appear in the language of the LabVIEW IDE.
|-
|-
! scope="row" style="text-align:left;" | Owning Class ID
! scope="row" style="text-align:left;" | Owning Class ID
| [[{{VIServerGetClassName|{{{1}}}}} class|{{{1}}}]]
| [[{{VIServerGetClassName|{{{classid}}}}} class|{{{classid}}}]]
|-
|-
! scope="row" style="text-align:left;" | Owning Class Name
! scope="row" style="text-align:left;" | Owning Class Name
| [[{{VIServerGetClassName|{{{1}}}}} class|{{VIServerGetClassName|{{{1}}}}} Class]]
| [[{{VIServerGetClassName|{{{classid}}}}} class|{{VIServerGetClassName|{{{classid}}}}} Class]]
|-
|-
! scope="row" style="text-align:left;" | Data Type
! scope="row" style="text-align:left;" | Data Type
| {{VIServerGetPropertyDataImage|{{{2}}}}}
| {{{datatypeimage}}}
{{VIServerGetPropertyDataType|{{{2}}}}}
{{{datatype}}}
|-
|-
! scope="row" style="text-align:left;" | Property Node
! scope="row" style="text-align:left;" | Property Node
| {{VIServerGetPropertyNodeImage|{{{2}}}}}
<!--Other Optional Parameters-->
{{{otherparams}}}
| {{{propertynodeimage}}}
{{#if: {{{availableinrealtime|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Available in Real-Time Operating System</b></td><td>{{{availableinrealtime}}}</td></tr>|}}
{{#if: {{{availableinruntime|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Available in Run-Time Engine</b></td><td>{{{availableinruntime}}}</td></tr>|}}
{{#if: {{{availablewithcontrolvis|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Available with control VIs</b></td><td>{{{availablewithcontrolvis}}}</td></tr>|}}
{{#if: {{{availablewithglobalvis|}}} |<tr><td style="background-color:#EAECF0; text-align:left;"><b>Available with global VIs</b></td><td>{{{availablewithglobalvis}}}</td></tr>|}}
{{#if: {{{availablewithpolyvis|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Available with polymorphic VIs</b></td><td>{{{availablewithpolyvis}}}</td></tr>|}}
{{#if: {{{availablewithstricttypedefs|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Available with strict type definitions</b></td><td>{{{availablewithstricttypedefs}}}</td></tr>|}}
{{#if: {{{loadsbd|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Loads the block diagram into memory</b></td><td>{{{loadsbd}}}</td></tr>|}}
{{#if: {{{loadsfp|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Loads the front panel into memory</b></td><td>{{{loadsfp}}}</td></tr>|}}
{{#if: {{{mustwait|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Must wait until user interface is idle</b></td><td>{{{mustwait}}}</td></tr>|}}
{{#if: {{{needsauthentication|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Need to authenticate before use</b></td><td>{{{needsauthentication}}}</td></tr>|}}
{{#if: {{{permissions|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Permissions</b></td><td>{{{permissions}}}</td></tr>|}}
{{#if: {{{remoteallowed|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Remote access allowed</b></td><td>{{{remoteallowed}}}</td></tr>|}}
{{#if: {{{settablewhenrunning|}}} | <tr><td style="background-color:#EAECF0; text-align:left;"><b>Settable when the VI is running</b></td><td>{{{settablewhenrunning}}}</td></tr>|}}
|}
|}
</includeonly>
</includeonly>
Line 44: Line 57:
<code>
<code>
<nowiki>
<nowiki>
{{VIServerProperty|{{{1}}}|{{{2}}}}}
{{VIServerProperty
| classid=
| propertyid=
| scope=
| dataname=
| shortname=
| longname=
| datatypeimage=
| datatype=
| propertynodeimage=
| availableinrealtime=
| availableinruntime=
| availablewithcontrolvis=
| availablewithglobalvis=
| availablewithpolyvis=
| availablewithstricttypedefs=
| loadsbd=
| loadsfp=
| mustwait=
| needsauthentication=
| permissions=
| remoteallowed=
| settablewhenrunning=
|}}
</nowiki>
</nowiki>
</code>
</code>
Line 68: Line 104:
<code>
<code>
<nowiki>
<nowiki>
{{VIServerProperty|36|632A813}}
{{VIServerProperty|classid=36|propertyid=632A813}}
</nowiki>
</nowiki>
</code>
</code>


<blockquote style="float: left;">
<blockquote style="float: left;">
{{VIServerProperty|36|632A813
{{VIServerProperty| classid = 36
| scope=basic
| propertyid = 632A813
| otherparams = {{!}}-
| scope = script
! scope="row" style="text-align:left" {{!}} Permissions
| dataname = UID
{{!}} Read Only
| shortname = UID
{{!}}-
| longname = UID
! scope="row" style="text-align:left" {{!}} Available in Run-Time Engine
| datatypeimage = I32.png
{{!}} Yes  
| datatype = I32
{{!}}-
| propertynodeimage = UID.png
! scope="row" style="text-align:left" {{!}} Available in Real-Time Operating System
| availableinrealtime = Yes
{{!}} Yes
| availableinruntime = Yes
{{!}}-
| loadsbd = No
! scope="row" style="text-align:left" {{!}} Settable when the VI is running
| loadsfp = No
{{!}} No
| needsauthentication = No
{{!}}-
| permissions = Read Only
! scope="row" style="text-align:left" {{!}} Loads the front panel into memory
| remoteallowed = Yes
{{!}} No
| settablewhenrunning = No
{{!}}-
! scope="row" style="text-align:left" {{!}} Need to authenticate before use
{{!}} No
{{!}}-
! scope="row" style="text-align:left" {{!}} Loads the block diagram into memory
{{!}} No
{{!}}-
! scope="row" style="text-align:left" {{!}} Remote access allowed
{{!}} Yes
}}
}}
</blockquote>
</blockquote>


</noinclude>
</noinclude>

Revision as of 23:19, 15 September 2019


Usage

Use this template is to create the Property Information table in VI Server property pages.

Syntax is as follows:

{{VIServerProperty | classid= | propertyid= | scope= | dataname= | shortname= | longname= | datatypeimage= | datatype= | propertynodeimage= | availableinrealtime= | availableinruntime= | availablewithcontrolvis= | availablewithglobalvis= | availablewithpolyvis= | availablewithstricttypedefs= | loadsbd= | loadsfp= | mustwait= | needsauthentication= | permissions= | remoteallowed= | settablewhenrunning= |}}

where:

Parameter Description Default
{{{1}}} The Class ID of a class in the VI Server Class Hierarchy.
{{{2}}} The Property ID of a property owned by the class defined by the Class ID {{{1}}}.

Example

{{VIServerProperty|classid=36|propertyid=632A813}}



VI Server Property Information
Property ID 632A813
Scope VI Scripting
Data Name UID
Short Name* UID
Long Name* UID
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 36
Owning Class Name GObject Class
Data Type I32.png

I32

Property Node UID.png
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Need to authenticate before useNo
PermissionsRead Only
Remote access allowedYes
Settable when the VI is runningNo