TestStand Adapter API Reference

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)
Object and Description
ActiveXAdapter
Use objects from the ActiveXAdapter class to configure and obtain ActiveX/COM Adapter-specific information about the module adapter. Call Engine.GetAdapter or Engine.GetAdapterByKeyName to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use AsAdapter to obtain an object.
ActiveXCoClass
Use an ActiveXCoClass object to obtain information about a coclass defined in a type library. Use the ActiveXServer.CoClasses property to obtain a collection of coclasses the type library for the server defines. You must call the ActiveXServer.LoadTypeLibrary method before accessing any coclass information for the server.
ActiveXCoClasses
A collection of ActiveXCoClass objects. Use the ActiveXServer.CoClasses property to obtain a collection of ActiveXCoClass objects the type library for the server defines. You must call the ActiveXServer.LoadTypeLibrary method before accessing any coclass information for the server.
ActiveXInterface
Use an ActiveXInterface object to obtain information about an interface defined in a type library. Use the ActiveXServer.Interfaces property to obtain a collection of interfaces the type library for the server defines. You must call the ActiveXServer.LoadTypeLibrary method before accessing any interface information for the server.
ActiveXInterfaces
A collection of ActiveXInterface objects. Use the ActiveXServer.Interfaces property to obtain a collection of interfaces the type library for the server defines. You must call the ActiveXServer.LoadTypeLibrary method before accessing any interface information for the server.
ActiveXMember
Use an ActiveXMember object to obtain information about a method or property defined in a type library. Use the ActiveXInterface.VTableMembers and ActiveXInterface.DispatchMembers properties to obtain a collection of members the type library for an interface of the server defines.
ActiveXMembers
A collection of ActiveXMember objects. Use the ActiveXInterface.VTableMembers and ActiveXInterface.DispatchMembers properties to obtain a collection of ActiveXMember objects defined for an interface in the type library of the server.
ActiveXModule
Use objects from the ActiveXModule class to specify and obtain ActiveX/COM Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to an ActiveXModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the ActiveXModule.AsModule method to obtain an object. You can use the Module.LoadPrototype method to load the prototype for the module the step specifies.
ActiveXParameter
Use objects from the ActiveXParameter class to configure and obtain parameter-specific information for an item in the ActiveXParameters collection class.
ActiveXParameters
Use objects from the ActiveXParameters class to configure and obtain parameters for a module that uses the ActiveX/COM Adapter. Use the ActiveXModule.Parameters property to obtain the collection of parameters for a module.
ActiveXServer
Use an ActiveXServer object to obtain information about a server and its type library registered on this computer. Use the ActiveXAdapter.Servers property to obtain a collection of ActiveXServer objects. You must call the ActiveXServer.LoadTypeLibrary method before you access any type library related properties.
ActiveXServers
A collection of ActiveXServer objects. Use the ActiveXAdapter.Servers property to obtain a collection of ActiveXServer objects. You must call the ActiveXServer.LoadTypeLibrary method before you access any type library related properties.
CommonCAdapter
Use objects from the CommonCAdapter class to configure and obtain common information about the LabWindows/CVI and C/C++ DLL Adapters. To access the properties and methods of the Adapter class, use the CommonCAdapter.AsAdapter method to obtain an object. To access the properties and methods of a specific adapter class, query the CommonCAdapter object for the interface of the adapter-specific interface you want.
CommonCModule
Use objects from the CommonCModule class to specify and obtain common information for the LabWindows/CVI and C/C++ DLL code modules that steps or step type substeps execute. Use the Step.Module property to obtain a reference to a CommonCModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the CommonCModule.AsModule method to obtain an object. To access the properties and methods of a specific module class, query the CommonCModule object for the interface of the module-specific interface you want to acquire. You can use the Module.LoadPrototype method to load the prototype for the module the step specifies.
CommonCParameter
Use objects from the CommonCParameter class to configure and obtain common parameter information for a CVIParameter or DllParameter object. To access the properties and methods of a specific parameter class, query the CommonCParameter object for the interface of the parameter-specific interface you want.
CVIAdapter
Use objects from the CVIAdapter class to configure and obtain LabWindows/CVI Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the CVIAdapter.AsAdapter method to obtain an object.
CVIArgument
Use objects from the CVIArgument class to set the argument value to pass to a LabWindows/CVI module function using the CVIModule.Execute method.
CVIArguments
Use objects from the CVIArguments class to pass specific argument values to a LabWindows/CVI module function using the CVIModule.Execute method. Use the CVIParameters.NewArguments method to create a new arguments collection.
CVIModule
Use objects from the CVIModule class to specify and obtain LabWindows/CVI Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to a CVIModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the CommonCModule class, use the CVIModule.AsCommonCModule method to obtain an object. You can use the Module.LoadPrototype method to load the prototype for the module the step specifies.
CVIParameter
Use objects from the CVIParameters class to configure and obtain LabWindows/CVI parameter-specific information for an item in the CVIParameter collection class. To access the properties and methods of the CommonCParameter class, use the CVIParameter.AsCommonCParameter method to obtain an object.
CVIParameters
Use objects from the CVIParameters class to configure and obtain parameters for a module that uses the LabWindows/CVI Adapter. Use the CVIModule.Parameters property to obtain the collection of parameters for a module.
DllAdapter
Use objects from the DllAdapter class to configure and obtain C/C++ DLL Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the DllAdapter.AsAdapter method to obtain an object.
DllArgument
Use objects from the DllArgument class to set the argument value to pass to a DLL module function using the DllModule.Execute method.
DllArguments
Use objects from the DllArguments class to pass specific argument values to a DLL module function using the DllModule.Execute method. Use the DllParameters.NewArguments method to create a new arguments collection.
DllFunction
Use objects from the DllFunction class to obtain information about a function exported from a DLL. Use the CommonCAdapter.GetDllFunctions method to obtain a collection of functions from a DLL.
DllFunctions
This class is a collection of DllFunction objects. Each item in the collection represents a function exported from a DLL that can be called from TestStand using the LabWindows/CVI or C/C++ DLL adapter. Use the CommonCAdapter.GetDllFunctions method to obtain a collection of functions from a DLL.
DllModule
Use objects from the DllModule class to specify and obtain C/C++ DLL Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to a DllModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the CommonCModule class, use the DllModule.AsCommonCModule method to obtain an object. You can use the Module.LoadPrototype method to load the prototype for the module the step specifies.
DllParameter
Use objects from the DllParameter class to configure and obtain C/C++ DLL parameter-specific information for an item in the DllParameters collection class. To access the properties and methods of the CommonCParameter class, use the DllParameter.AsCommonCParameter method.
DllParameters
Use objects from the DllParameters class to configure and obtain parameters for a module that uses the C/C++ DLL Adapter. Use the DllModule.Parameters property to obtain the collection of parameters for a module.
DotNetAdapter
Use objects from the DotNetAdapter class to configure and obtain .NET Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the DotNetAdapter.AsAdapter method to obtain an object.
DotNetArgument
Use objects from this class to specify the argument value to pass to a DotNetCall object using the DotNetModule.Execute method.
DotNetArguments
Use objects from this class to pass specific argument values to a specific DotNetCall object using the DotNetModule.Execute method. Use the DotNetModule.NewModuleArguments method to create a new DotNetModuleArguments collection of DotNetArguments objects.
DotNetCall
Use objects from the DotNetCall class to specify and obtain .NET Adapter-specific information about the code module that steps or step type substeps execute. Typically, you use this class only when you are writing a sequence editor. You can use the DotNetCall.LoadPrototypeFromSignature method to load the prototype for the call.
DotNetCalls
Use objects from the DotNetCalls class to configure and obtain calls for a module the .NET Adapter uses. Use the DotNetModule.Calls property to obtain the collection of calls for a module.
DotNetModule
Use objects from the DotNetModule class to specify and obtain .NET Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to a DotNetModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the DotNetModule.AsModule method to obtain an object.
DotNetModuleArguments
Use objects from this class to pass specific argument values to a DotNetModule object using the DotNetModule.Execute method. Use the DotNetModule.NewModuleArguments method to create a new DotNetModuleArguments collection.
DotNetParameter
Use objects from the DotNetParameters class to configure and obtain parameters for a module that uses the .NET Adapter. Use the DotNetCall.Parameters property to obtain the collection of parameters for a module and the DotNetParameter.Elements property to obtain the collection that represents the members of a structure parameter or the elements of an array of structures parameter.
DotNetParameters
Use objects from the DotNetParameters class to configure and obtain parameters for a DotNetCall. Use the DotNetCall.Parameters property to obtain the collection of parameters for a call and the DotNetParameter.Elements method to obtain the collection that represents the members of a structure parameter or the elements of an array of structures parameter.
HTBasicAdapter
Use objects from the HTBasicAdapter class to configure and obtain HTBasic Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the HTBasicAdapter.AsAdapter method to obtain an object.
HTBasicModule
Use objects from the HTBasicModule class to specify and obtain HTBasic Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to an HTBasicModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the HTBasicModule.AsModule method to obtain an object.
LabVIEWAdapter
Use objects from the LabVIEW Adapter class to configure and obtain LabVIEW Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the LabVIEWAdapter.AsAdapter method to obtain an object.
LabVIEWArgument
Use objects from the LabVIEWArgument class to set the argument value to pass to a LabVIEW VI using the LabVIEWModule.Execute method.
LabVIEWArguments
Use objects from the LabVIEWArguments class to pass specific argument values to a LabVIEW VI using the LabVIEWModule.Execute method. Use the LabVIEWParameters.NewArguments method to create a new arguments collection.
LabVIEWModule
Use objects from the LabVIEWModule class to specify and obtain LabVIEW Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to a LabVIEWModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the LabVIEWModule.AsModule method to obtain an object. You can use the Module.LoadPrototype method to load the prototype for the module the step specifies.
LabVIEWNodeProperties
Use objects from the LabVIEWNodeProperties class to configure and obtain LabVIEWNodeProperties for a module that uses the LabVIEW Adapter. Use the LabVIEWModule.NodeProperties property to obtain the collection of LabVIEWNodeProperties for a module.
LabVIEWNodeProperty
Use objects from the LabVIEWNodeProperty class to configure and obtain LabVIEWNodeProperty-specific information for an item in the LabVIEWNodeProperties collection class.
LabVIEWNXGAdapter
Use objects from the LabVIEW NXG Adapter class to configure and obtain LabVIEW NXG Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the LabVIEWNXGAdapter.AsAdapter method to obtain an object.
LabVIEWNXGArgument
Use objects from the LabVIEWNXGArgument class to set the argument value to pass to a LabVIEW NXG VI using the LabVIEWNXGModule.Execute; method.
LabVIEWNXGArguments
Use objects from the LabVIEWNXGArguments class to pass specific argument values to a LabVIEW NXG VI using the LabVIEWNXGModule.Execute; method. Use the LabVIEWNXGParameters.NewArguments; method to create a new arguments collection.
LabVIEWNXGModule
Use objects from the LabVIEWNXGModule class to specify and obtain LabVIEW NXG Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module; property to obtain a reference to a LabVIEWNXGModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the LabVIEWNXGModule.AsModule; method to obtain an object. You can use the Module.LoadPrototype; method to load the prototype for the module the step specifies.
LabVIEWNXGNodeProperties
Use objects from the LabVIEWNXGNodeProperties class to configure and obtain LabVIEWNXGNodeProperties for a module that uses the LabVIEW NXG Adapter. Use the LabVIEWNXGModule.NodeProperties property to obtain the collection of LabVIEWNXGNodeProperties for a module.
LabVIEWNXGNodeProperty
Use objects from the LabVIEWNXGNodeProperty class to configure and obtain LabVIEWNXGNodeProperty-specific information for an item in the LabVIEWNXGNodeProperties collection class.
LabVIEWNXGParameter
Use objects from the LabVIEWNXGParameter class to configure and obtain LabVIEWNXGParameter-specific information for an item in the LabVIEWNXGParameters collection class.
LabVIEWNXGParameters
Use objects from the LabVIEWNXGParameters class to configure and obtain parameters for a module that uses the LabVIEW NXG Adapter. Use the LabVIEWNXGModule.Parameters property to obtain the collection of parameters for a module.
LabVIEWNXGProject
Use the objects in the LabVIEWNXGProject class to obtain information about the items present in the LabVIEW NXG project.
LabVIEWNXGProjectItem
Use the objects in the LabVIEWNXGProjectItem class to obtain project item details such as path, component name, and so on.
LabVIEWNXGProjectItems
Use objects from the LabVIEWNXGProjectItems class to configure and obtain project items for a module that uses the LabVIEW NXG Adapter.
LabVIEWParameter
Use objects from the LabVIEWParameter class to configure and obtain LabVIEWParameter-specific information for an item in the LabVIEWParameters collection class.
LabVIEWParameterElement
Use objects from the LabVIEWParameterElement class to configure and obtain element-specific information in a cluster or array parameter of a module. Use the LabVIEWParameter.Elements property to obtain the collection of elements for a parameter of a module.
LabVIEWParameterElements
Use objects from the LabVIEWParameterElements class to configure and obtain elements for a cluster or array parameter of a module that uses the LabVIEW Adapter. Use the LabVIEWParameter.Elements property to obtain the collection of elements for a parameter of a module and the LabVIEWParameterElement.Elements property to obtain the collection of sub-elements for a parameter element.
LabVIEWParameters
Use objects from the LabVIEWParameters class to configure and obtain parameters for a module that uses the LabVIEW Adapter. Use the LabVIEWModule.Parameters property to obtain the collection of parameters for a module.
PythonAdapter
Use objects from the PythonAdapter class to configure and obtain Python Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the PythonAdapter.AsAdapter method to obtain an object.
PythonArgument
Use objects from the PythonArgument class to set the argument value to pass to a Python module operation (function call, get/set attribute, create class instance) using the PythonModule.Execute method. Use the PythonArguments.Item property to obtain the PythonArgument objects.
PythonArguments
Use the object of the PythonArguments class to pass specific argument values to a Python module operation (function call, get/set attribute, create class instance) using the PythonModule.Execute method. Use the PythonModule.Arguments property to obtain the PythonArguments object. Creating a new PythonArguments object using the PythonModule.NewArguments method populates this collection of PythonArgument objects. The number of PythonArgument objects is the same as the number of PythonParameter objects for the PythonModule.
PythonModule
Use objects from the PythonModule class to specify and obtain Python Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to a PythonModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the PythonModule.AsModule method to obtain an object.
PythonParameter
Use objects from the PythonParameter class to configure and obtain parameter-specific information for an item in the PythonParameters collection class. Use the PythonModule.Parameters property to obtain the collection of parameters for a module.
PythonParameters
Use objects from the PythonParameters class to configure and obtain parameters for a module that uses the Python Adapter. Use the PythonModule.Parameters property to obtain the collection of parameters for a module.
SequenceAdapter
Use objects from the Sequence Adapter class to configure and obtain Sequence Adapter-specific information about the module adapter. Call the Engine.GetAdapter or Engine.GetAdapterByKeyName method to obtain a reference to the adapter object. To access the properties and methods of the Adapter class, use the SequenceAdapter.AsAdapter method to obtain an object.
SequenceCallModule
Use objects from the SequenceCallModule class to specify and obtain Sequence Adapter-specific information about the code module that steps or step type substeps execute. Use the Step.Module property to obtain a reference to a SequenceCallModule object. To access the properties and methods of a specific module class, query the Module object for the interface of the module-specific interface you want to acquire. Typically, you use this class only when you are writing a sequence editor. To access the properties and methods of the Module class, use the AsModule method to obtain an object. You can use the Module.LoadPrototype method to load the prototype for the module that the step specifies.
SequenceCallParameter
Use objects from the SequenceCallParameter class to configure and obtain SequenceCallParameter-specific information for an item in the SequenceCallParameters collection class.
SequenceCallParameters
Use objects from the SequenceCallParameters class to configure and obtain parameters for a module that uses the Sequence Adapter. Use the SequenceCallModule.Parameters property to obtain the collection of parameters for a module.

WAS THIS ARTICLE HELPFUL?

Not Helpful