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.
Framework
hwIPPTPublish Class
hwIPPTPublish GetSyncHgNotes
Gets whether or not to sync HyperGraph notes.

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
      - amfIMarker Class
      - amfIMeasure Class
      - amfIMovie Class
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
      - hwIAnimator Class
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
        hwIPPTPublish CloseLinkedPPT
        Closes the linked PowerPoint file.
        hwIPPTPublish GetClassName
        Returns the class name.
        hwIPPTPublish GetDestination
        Gets the destination type for the published session.
        hwIPPTPublish GetOpenPpt
        Gets the active open PowerPoint filename.
        hwIPPTPublish GetOpenPptList
        Gets a list of the Open PowerPoint names published from the session.
        hwIPPTPublish GetPathOnDisk
        Gets the path on the disk for the published session.
        hwIPPTPublish GetPPTOptionsHandle
        Gets the handle which provides the provision to use different options.
        hwIPPTPublish GetSyncAtPublish
        Gets whether or not to sync when you publish from HyperWorks Desktop.
        hwIPPTPublish GetSyncHgNotes
        Gets whether or not to sync HyperGraph notes.
        hwIPPTPublish Publish
        Publishes the present session.
        hwIPPTPublish SaveLinkedPptPresentation
        Saves the linked PowerPoint file to the selected filename.
        hwIPPTPublish SetDestination
        Sets the destination/location to publish the session.
        hwIPPTPublish SetOpenPpt
        Sets the active PowerPoint filename.
        hwIPPTPublish SetPathOnDisk
        Sets the path that you define.
        hwIPPTPublish SetSyncAtPublish
        Sets whether or not to sync at publishing.
        hwIPPTPublish SetSyncHgNotes
        Sets whether or not to sync HyperGraph notes when publishing.
        hwIPPTPublish Synchronize
        Synchronizes images/animations in a HyperMesh session.
      - hwIPPTPublishOption Class
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - HyperGraph 2D
    - 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.

hwIPPTPublish GetSyncHgNotes

Gets whether or not to sync HyperGraph notes.

Syntax

hwIPPTPublish_handle GetSyncHgNotes

Application

Tcl Query

Description

Outputs the string (either true or false) defined in SetSynchHgNotes or from the PowerPoint user interface.

Example

To returns whether or not to sync HyperGraph notes:

PPTPublish GetSyncHgNotes

Error

Returns success (0) or an error code.

Keywords

Tcl

Query