Cleanup Callback

TestStand ATML Toolkit 2017 Help

Edition Date: June 2018

Part Number: 374205B-01

»View Product Info
Download Help (Windows Only)

The ATML TD translator calls the Cleanup callback only once per translation and after translating the complete TD instance document.

Typical Use

Use the Cleanup callback to deallocate resources the Setup callback allocated.

LabVIEW

The following figure shows the controls and indicators connected to the VI connector pane.

CodeGenerator_Cleanup.vi

  • TranslatorCodeGenerator—Automation Refnum control that uses the TranslatorCodeGenerator interface.
  • DOMDocument—Automation Refnum control that uses the MSXML DOM Document of the TD instance document.
  • Error Out—The error out cluster, which contains the error status, code, and source information.

LabWindows/CVI

LabWindows/CVI Function Prototype

HRESULT __stdcall CodeGenerator_Cleanup(
IDispatch * translatorCodeGen,
IDispatch * domDocument,
long* errorCode,
BSTR* errorDescription )

Microsoft Visual C++ Function Prototype

extern "C" HRESULT __stdcall CodeGenerator_Cleanup(
TranslatorCodeGenerator* translatorCodeGen,
MSXML2::IXMLDOMDocument2* domDocument,
long* errorCode,
BSTR* errorDescription )

Parameters

  • translatorCodeGen—Instance that implements TranslatorCodeGenerator interface.
  • domDocument—MSXML DOM Document of the TD instance document.
  • errorCode—Error code to log in the log file.
  • errorDescription—Error description of the error code.

See Also

Creating a DLL for a LabWindows/CVI Custom Code Generator

Creating a VI for a LabVIEW Custom Code Generator

Example LabVIEW Custom Code Generator VIs

Recommended LabWindows/CVI Function Prototypes

Recommended Microsoft Visual C++ Function Prototypes

Setup Callback

TranslatorCodeGenerator

WAS THIS ARTICLE HELPFUL?

Not Helpful