Template:VIServerMethod/doc

This is the documentation page for Template:VIServerMethod.

When it is viewed directly, links using variables may appear broken; do not replace these with hardcoded page names or URLs.

Usage

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

Syntax is as follows:

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

where:

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

Example

{{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 |}}

Result

VI Server Method Information
Method ID	7D5
Scope	Basic Development Environment
Data Name	Mass Compile
Short Name*	Mass Compile
Long Name*	Mass Compile
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID	1
Owning Class Name	Application Class
Return Data Type	No return value
Invoke Node
Available in Real-Time Operating System	Yes
Available in Run-Time Engine	No
Remote access allowed	Yes