Jump to content

CallLibrary class: Difference between revisions

From LabVIEW Wiki
Newer edit →
Visual
Started page
 
Replaced with template tables
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide CallLibrary Properties Table</span>
{{VIServerClassTables|16417}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ CallLibrary Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|636D40D
| [[CallLibrary class/AbortCallback property|AbortCallback]]
|Sets or returns the name of the abort callback function that LabVIEW calls.
|R/W
|
|- style="background-color:#D1BB80;"
|636D405
| [[CallLibrary class/AllowPrealloc property|AllowPrealloc]]
|
|R/W
|X
|- style="background-color:#CCFFFF;"
|636D403
| [[CallLibrary class/AnyThread property|AnyThread]]
|Indicates whether the function is reentrant.
|R/W
|
|- style="background-color:#CCFFFF;"
|636D402
| [[CallLibrary class/CallConvention property|CallConvention]]
|Uses the calling conventions to call libraries.
 
Valid values include 0 (C Call) and 1 (stdcall (WINAPI)).
|R/W
|
|- style="background-color:#CCFFFF;"
|636D40A
| [[CallLibrary class/DynamicLib property|DynamicLib]]
|Sets the Call Library Function Node, in write mode, to execute with the library path you specify. In read mode, this property returns whether LabVIEW configures the Call Library Function Node to load the library dynamically.
 
With the dynamic library property set in write mode, the library loads when LabVIEW executes the node. When you wire a different path, the Call Library Function Node unloads the previous library and loads the new library. When you wire a NULL path, the Call Library Function Node unloads the previous library and loads the NULL path in the same way.
|R/W
|
|- style="background-color:#CCFFFF;"
|636D40E
| [[CallLibrary class/ErrorCheckingLevel property|ErrorCheckingLevel]]
|Sets or returns the error level for the Call Library Function Node.
 
Valid values include 0 (maximum), 1 (default), and 2 (disabled).
|R/W
|
|- style="background-color:#CCFFFF;"
|636D401
| [[CallLibrary class/FuncName property|FuncName]]
|Sets or returns the name of the function you configure the Call Library Function Node to call.
|R/W
|
|- style="background-color:#CCFFFF;"
|636D408
| [[CallLibrary class/InputTerms property|InputTerms]]
|Returns a 1D array of references to the input parameters.
|R
|X
|- style="background-color:#CCFFFF;"
|636D400
| [[CallLibrary class/LibPath property|LibPath]]
|Specifies the path to the DLL or shared library the Call Library Function Node calls.
|R/W
|
|- style="background-color:#D1BB80;"
|636D406
| [[CallLibrary class/NIValidated property|NIValidated]]
|
|R/W
|X
|- style="background-color:#CCFFFF;"
|636D407
| [[CallLibrary class/OutputTerms property|OutputTerms]]
|Returns a 1D array of references to the output parameters.
|R
|X
|- style="background-color:#CCFFFF;"
|636D409
| [[CallLibrary class/ParamInfo property|ParamInfo]]
|Sets or returns an array of clusters with information for the parameters of a function.
 
Each cluster in the array represents a parameter of the function, starting with the return value. The property only returns the fields relevant to the parameter type. For example, if the parameter type is a numeric, the property returns a value to the <b>Param Passing</b> element but not to the <b>Array Passing</b> element.
|R/W
|X
|- style="background-color:#CCFFFF;"
|636D40B
| [[CallLibrary class/ReserveCallback property|ReserveCallback]]
|Sets or returns the name of the reserve callback function that LabVIEW calls.
|R/W
|
|- style="background-color:#CCFFFF;"
|636D40C
| [[CallLibrary class/UnreserveCallback property|UnreserveCallback]]
|Sets or returns the name of the unreserve callback function that LabVIEW calls.
|R/W
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide CallLibrary Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ CallLibrary Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|636D001
| [[CallLibrary class/CreateCFile method|CreateCFile]]
|Creates a C file for the Call Library Function Node at the specified path.
|X
|- style="background-color:#CCFFFF;"
|636D000
| [[CallLibrary class/Prototype method|Prototype]]
|Returns the C prototype string for the currently configured function.
|
|- style="background-color:#D1BB80;"
|636D002
| [[CallLibrary class/TypeOnlyParam method|TypeOnlyParam]]
|
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 00:16, 9 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name CallLibrary class
Class ID 16417
Scope VI Scripting
Class Inheritance
Class Children

This class has no children.


    This article is a stub. You can help LabVIEW Wiki by expanding it.
    Please improve this article if you can.

    The CallLibrary class is a class in the VI Server Class Hierarchy, (see also VI Server).

    Properties

    Show/Hide CallLibrary Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    CallLibrary Properties Table
    Property ID Long Name (English) Description R/W RTE
    636D400Library PathSpecifies the path to the DLL or shared library the Call Library Function Node calls.Read/WriteNo
    636D401Function NameSets or returns the name of the function you configure the Call Library Function Node to call.Read/WriteNo
    636D402Calling ConventionUses the calling conventions to call libraries.Read/WriteNo
    636D403Any Thread?Indicates whether the function is reentrant.Read/WriteNo
    636D404Old Parameter InfoRead/WriteNo
    636D405Allow PreallocationRead/WriteYes
    636D406NI ValidatedRead/WriteYes
    636D407Output Terminals []Returns a 1D array of references to the output parameters.Read OnlyYes
    636D408Input Terminals[]Returns a 1D array of references to the input parameters.Read OnlyYes
    636D409Parameter InfoSets or returns an array of clusters with information for the parameters of a function.Read/WriteYes
    636D40ADynamic Library?Sets the Call Library Function Node, in write mode, to execute with the library path you specify. In read mode, this property returns whether LabVIEW configures the Call Library Function Node to load the library dynamically.Read/WriteNo
    636D40BReserve CallbackSets or returns the name of the reserve callback function that LabVIEW calls.Read/WriteNo
    636D40CUnreserve CallbackSets or returns the name of the unreserve callback function that LabVIEW calls.Read/WriteNo
    636D40DAbort CallbackSets or returns the name of the abort callback function that LabVIEW calls.Read/WriteNo
    636D40EError Checking LevelSets or returns the error level for the Call Library Function Node.Read/WriteNo

    Methods

    Show/Hide CallLibrary Properties Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    CallLibrary Methods Table
    Method ID Long Name (English) Description RTE
    636D000PrototypeReturns the C prototype string for the currently configured function.No
    636D001Create C FileCreates a C file for the Call Library Function Node at the specified path.Yes (Read/Write)
    636D002Type Only ParamYes

    Events

    This class has no events or it inherits events from its parent: GrowableFunction Class.


    History

    History information is needed. What changes have occurred over previous versions?
    Version Change(s)
    LabVIEW 2018 More info to come.

    See Also

    Retrieved from "https://labviewwiki.org/w/index.php?title=CallLibrary_class&oldid=9840"