Logmanoriginal: Move documentation to subpage

2024-08-01T17:02:39Z

Move documentation to subpage

Q at 00:33, 17 April 2020

2020-04-17T00:33:45Z

← Older revision		Revision as of 00:33, 17 April 2020
Line 187:		Line 187:
	<nowiki>		<nowiki>
	{{VIServerMethod\| classid = 1		{{VIServerMethod\| classid = 1
	\| methodid = ~~7d5~~		\| methodid = 7D5
	\| scope=basic		\| scope=basic
	\| dataname = Mass Compile		\| dataname = Mass Compile
Line 204:		Line 204:
	<blockquote style="float: left;">		<blockquote style="float: left;">
	{{VIServerMethod\| classid = 1		{{VIServerMethod\| classid = 1
	\| methodid = ~~7d5~~		\| methodid = 7D5
	\| scope=basic		\| scope=basic
	\| dataname = Mass Compile		\| dataname = Mass Compile

Q: Created Method Information Template

2020-04-17T00:28:54Z

Created Method Information Template

New page

<includeonly>{| class="wikitable" style="float:left; margin-right: 20px;"
! colspan="2" | VI Server Method Information
|-
! scope="row" style="text-align:left;" | Method ID
| {{{methodid}}}
|- {{#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
| {{#switch: {{{scope}}} | basic = [[VI Server#Basic Development Environment|Basic Development Environment]] | script = [[VI Server#VI Scripting|VI Scripting]] | private = [[VI Server#Private|Private]] | deprecated = [[VI Server#Deprecated|Deprecated]]}}
|-
! scope="row" style="text-align:left;" | Data Name
| {{{dataname}}}
|-
! scope="row" style="text-align:left;" | Short Name*
| {{{shortname}}}
|-
! scope="row" style="text-align:left;" | Long Name*
| {{{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.
|-
! scope="row" style="text-align:left;" | Owning Class ID
| [[{{VIServerGetClassName|{{{classid}}}}} class|{{{classid}}}]]
|-
! scope="row" style="text-align:left;" | Owning Class Name
| [[{{VIServerGetClassName|{{{classid}}}}} class|{{VIServerGetClassName|{{{classid}}}}} Class]]
|-
! scope="row" style="text-align:left;" | Return Data Type
| {{#ifeq: {{{datatypeimage}}} | none | {{{datatype}}} | [[{{{datatype}}} data type]]
[[File:{{{datatypeimage}}}|frameless|border|{{{datatype}}}|link={{{datatype}}} data type]]}}
|-
! scope="row" style="text-align:left;" | Invoke Node
| [[File:{{{invokenodeimage}}}|frameless|border|{{{longname}}}]]
{{#if: {{{availableinrealtime|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Available in Real-Time Operating System</td><td>{{{availableinrealtime}}}</td></tr>
|}}{{#if: {{{availableinruntime|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Available in Run-Time Engine</td><td>{{{availableinruntime}}}</td></tr>
|}}{{#if: {{{availablewithcontrolvis|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Available with control VIs</td><td>{{{availablewithcontrolvis}}}</td></tr>
|}}{{#if: {{{availablewithglobalvis|}}} |<tr><td style="background-color:#EAECF0; text-align:left;">Available with global VIs</td><td>{{{availablewithglobalvis}}}</td></tr>
|}}{{#if: {{{availablewithpolyvis|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Available with polymorphic VIs</td><td>{{{availablewithpolyvis}}}</td></tr>
|}}{{#if: {{{availablewithstricttypedefs|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Available with strict type definitions</td><td>{{{availablewithstricttypedefs}}}</td></tr>
|}}{{#if: {{{loadsbd|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Loads the block diagram into memory</td><td>{{{loadsbd}}}</td></tr>
|}}{{#if: {{{loadsfp|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Loads the front panel into memory</td><td>{{{loadsfp}}}</td></tr>
|}}{{#if: {{{mustwait|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Must wait until user interface is idle</td><td>{{{mustwait}}}</td></tr>
|}}{{#if: {{{needsauthentication|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Need to authenticate before use</td><td>{{{needsauthentication}}}</td></tr>
|}}{{#if: {{{permissions|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Permissions</td><td>{{{permissions}}}</td></tr>
|}}{{#if: {{{remoteallowed|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Remote access allowed</td><td>{{{remoteallowed}}}</td></tr>
|}}{{#if: {{{settablewhenrunning|}}} | <tr><td style="background-color:#EAECF0; text-align:left;">Settable when the VI is running</td><td>{{{settablewhenrunning}}}</td></tr>
|}}
|}</includeonly>
<noinclude>

== Usage ==

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

Syntax is as follows:

<code>
<nowiki>
{{VIServerMethod
| classid =
| methodid =
| scope =
| dataname =
| shortname =
| longname =
| datatypeimage =
| datatype =
| invokenodeimage =
| availableinrealtime =
| availableinruntime =
| availablewithcontrolvis =
| availablewithglobalvis =
| availablewithpolyvis =
| availablewithstricttypedefs =
| loadsbd =
| loadsfp =
| mustwait =
| needsauthentication =
| permissions =
| remoteallowed =
| settablewhenrunning =
|}}
</nowiki>
</code>

where:

{| class="wikitable"
! Parameter
! Description
! Default
|-
| <code>classid</code>
| The Class ID of a class in the [[VI Server Class Hierarchy]].
| <code></code>
|-
| <code>methodid</code>
| The Method ID of the method owned by the class defined by the Class ID {{{classid}}}.
| <code></code>
|-
| <code>scope</code>
| The scope of the method as either {basic, script, private, deprecated}.
| <code></code>
|-
| <code>dataname</code>
| The data name of the method.
| <code></code>
|-
| <code>shortname</code>
| The short name of the method.
| <code></code>
|-
| <code>longname</code>
| The long name of the method.
| <code></code>
|-
| <code>datatypeimage</code>
| The filename to the wiki image for the data type terminal for the method.
| <code></code>
|-
| <code>datatype</code>
| The data type of the method.
| <code></code>
|-
| <code>invokenodeimage</code>
| The filename to the wiki image for the invoke node for the method.
| <code></code>
|-
| <code>availableinrealtime</code>
| The value for "Available in Real-Time Operating System".
| <code></code>
|-
| <code>availableinrealtime</code>
| The value for "Available in Real-Time Operating System".
| <code></code>
|-
| <code>availableinruntime</code>
| The value for "Available in Run-Time Engine".
| <code></code>
|-
| <code>availablewithcontrolvis</code>
| The value for "Available with control VIs".
| <code></code>
|-
| <code>availablewithglobalvis</code>
| The value for "Available with global VIs".
| <code></code>
|-
| <code>availablewithpolyvis</code>
| The value for "Available with polymorphic VIs".
| <code></code>
|-
| <code>availablewithstricttypedefs</code>
| The value for "Available with strict type definitions".
| <code></code>
|-
| <code>loadsbd</code>
| The value for "Loads the block diagram into memory".
| <code></code>
|-
| <code>loadsfp</code>
| The value for "Loads the front panel into memory".
| <code></code>
|-
| <code>mustwait</code>
| The value for "Must wait until user interface is idle".
| <code></code>
|-
| <code>needsauthentication</code>
| The value for "Need to authenticate before use".
| <code></code>
|-
| <code>permissions</code>
| The value for "Permissions".
| <code></code>
|-
| <code>remoteallowed</code>
| The value for "Remote access allowed".
| <code></code>
|-
| <code>settablewhenrunning</code>
| The value for "Settable when the VI is running".
| <code></code>
|}

===Example===
<code>
<nowiki>
{{VIServerMethod| classid = 1
| methodid = 7d5
| scope=basic
| dataname = Mass Compile
| shortname = Mass Compile
| longname = Mass Compile
| datatypeimage = none
| datatype = No return value
| invokenodeimage = Application-Mass Compile.png
| availableinrealtime = Yes
| availableinruntime = No
| remoteallowed = Yes
|}}
</nowiki>
</code>
===Result===
<blockquote style="float: left;">
{{VIServerMethod| classid = 1
| methodid = 7d5
| scope=basic
| dataname = Mass Compile
| shortname = Mass Compile
| longname = Mass Compile
| datatypeimage = none
| datatype = No return value
| invokenodeimage = Application-Mass Compile.png
| availableinrealtime = Yes
| availableinruntime = No
| remoteallowed = Yes
|}}
</blockquote>

</noinclude>

Template:VIServerMethod - Revision history

Logmanoriginal: Move documentation to subpage

Q at 00:33, 17 April 2020

Q: Created Method Information Template