Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
Tcl/Tk Commands
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following Altair HyperWorks applications.
HyperGraph 2D
pltIPlotManager Class
pltIPlotManager GetExportCtrlHandle
Gets the export control handle.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
- Batch Mode
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
  - Tcl/Tk Classes
    Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
  - Script Use Cases
    Examples of script uses cases.
  - Tcl/Tk Example
    Learn more about Tcl/Tk with this basic example.
  - Program with Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
    - HyperGraph 2D
      - pltIAdvancedDrawControl Class
      - pltIAnimationCursor Class
      - pltIAxis Class
      - pltIBuildPlotsCtrl Class
      - pltICursor Class
      - pltICurve Class
      - pltICurveComplex Class
      - pltIDataAttribute Class
      - pltIDatum Class
      - pltIDrawControl Class
      - pltIEdit Class
      - pltIExportCtrl Class
      - pltILegend Class
      - pltIMacro Class
      - pltINote Class
      - pltIPlot Class
      - pltIPlotManager Class
        pltIPlotManager AddMacro
        Adds a Macro.
        pltIPlotManager AddStatisticsTemplate
        Adds a statistics template.
        pltIPlotManager CopyMacro
        Copies a Macro.
        pltIPlotManager GetBuildPlotsCtrlHandle
        Gets the build plots control handle.
        pltIPlotManager GetDefaultDynamicRange
        Finds the default dynamic range.
        pltIPlotManager GetExportCtrlHandle
        Gets the export control handle.
        pltIPlotManager GetMacroHandle
        Gets the macro handle.
        pltIPlotManager GetNumberOfEntitiesOnClipboard
        Finds the number of objects on the clipboard.
        pltIPlotManager GetNumberOfMacros
        Finds the number of macros.
        pltIPlotManager GetNumberOfStatisticsTemplates
        Finds the total number of statistics templates.
        pltIPlotManager GetPreloadMaximum
        Returns the preload maximum file size for post-processing a large number of pedestrian results.
        pltIPlotManager GetStatisticsTemplateHandle
        Gets a specific statistics template handle.
        pltIPlotManager GetUseEvenCycles
        Determines the state of the Use Even Cycles option.
        pltIPlotManager PasteMacro
        Pastes a macro.
        pltIPlotManager Recalculate
        Recalculates all data.
        pltIPlotManager RegisterExportTemplate
        Registers and saves an export template based on an exported file.
        pltIPlotManager RemoveMacro
        Removes a macro.
        pltIPlotManager RemoveStatisticsTemplate
        Removes a statistics template.
        pltIPlotManager SetDefaultDynamicRange
        Sets the default dynamic range.
        pltIPlotManager SetPreloadMaximum
        Sets the preload maximum file size for post-processing a large number of pedestrian result files.
        pltIPlotManager SetUseEvenCycles
        Sets the state of the Use Even Cycles option.
        pltIPlotManager UndoMacro
        Undoes a macro.
      - pltIStatisticsTemplate Class
      - pltITitle Class
      - pltIVector Class
      - pltIVectorComplex Class
      - pltIViewControl Class
      - pulIAxis Class
      - pulIDataExtractor Class
      - pulIDataGroup Class
      - pulIMacro Class
      - pulIMacroParameter Class
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

pltIPlotManager GetExportCtrlHandle

Gets the export control handle.

Syntax

pltIPlotManager_handle GetExportCtrlHandle iExp

Application

Tcl Query

Description

This command gets the export control handle. With the export control handle, you can modify the aspects of the export, including format, the file name, and the source. You can also export files with the export control handle.

Inputs

iExp: The name that you want to call the export control handle.

Example

hwi GetSessionHandle sess;
sess GetClientManagerHandle pm Plot;
pm GetExportCtrlHandle exp;

Errors

Success (0) or an error message is returned.

Keywords

Tcl

Export

Query