HyperWorks Desktop

2021.1

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop 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 HyperWorks Desktop applications.
HyperWorks Desktop
hwISession Class
hwISession Close
Closes the session.

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

2021.1

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Create, open, import, and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
HyperWorks Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with HyperWorks to enhance or extend the user experience.
- HyperWorks Desktop
  - 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.
  - Tcl/Tk Commands
    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
    - Program with HyperWorks APIs for Beginners
      APIs can be used to perform various actions in HyperWorks. For example, the AddPage API can be used to add a page within the project.
    - Object Hierarchy
      Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, 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 HyperWorks Tcl/Tk Command Tutorials
      Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
    - Tcl/Tk Commands
      Tcl/Tk classes for the following HyperWorks Desktop applications.
      - HyperWorks Desktop
        
        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
        
        hwIJPGExportOptions Class
        
        hwILayer Class
        
        hwIMessageLog Class
        
        hwIObject Class
        
        hwIPage Class
        
        hwIPPTPublish Class
        
        hwIPPTPublishOption Class
        
        hwIPreferenceManager Class
        
        hwIProject Class
        
        hwIReportTemplate Class
        
        hwISession Class
        
        hwISession AddPrinter
        Adds a printer to the printer list.
        
        hwISession ApplyReport
        Applies a report.
        
        hwISession CaptureActiveWindow
        Capture the active window to an image file of a specific dimension.
        
        hwISession CaptureAnimation
        Creates a movie file by animating the current page.
        
        hwISession CaptureAnimationByArea
        Creates a movie file by animating the current page, allowing you to first draw a box and select a sub-rectangle of the page for capture.
        
        hwISession CaptureAnimationByAreaPercentage
        Captures the screen to a movie file.
        
        hwISession CaptureAnimationByWindow
        Creates a video file of a window on the current page.
        
        hwISession CaptureDesktop
        Captures the entire desktop to an image file.
        
        hwISession CaptureDesktopByArea
        Captures a portion of the desktop to an image file.
        
        hwISession CaptureScreen
        Captures the current screen to an image file.
        
        hwISession CaptureScreenByArea
        Captures the screen to an image file.
        
        hwISession CaptureScreenByAreaPercentage
        Captures the screen to an image file.
        
        hwISession CaptureScreenToSize
        Captures the current screen to an image file of the specified pixel resolution.
        
        hwISession CaptureWindow
        Creates an image file of a window on the current page.
        
        hwISession ClearExternalSolvers
        Clears the list of registered external solvers.
        
        hwISession ClearWaitCursor
        Clears a visible wait mouse cursor.
        
        hwISession Close
        Closes the session.
        
        hwISession DeleteReport
        Deletes the given report.
        
        hwISession ExportCurves
        Exports curves in the given format.
        
        hwISession GetAMFExportOptionsHandle
        Returns the AMF export options interface handle for the session.
        
        hwISession GetApplicationTitle
        Finds the application title.
        
        hwISession GetAVIExportOptionsHandle
        Obtain a handle to the session’s AVIExportOptions object
        
        hwISession GetClientDisplayNameList
        Lists the display names of the clients that are available.
        
        hwISession GetClientInfoHandle
        Gets the client info handle.
        
        hwISession GetClientList
        Gets a list of all the currently available clients.
        
        hwISession GetClientManagerHandle
        Returns the client manager interface object.
        
        hwISession GetCurrentClient
        Returns the name of the active client.
        
        hwISession GetCurrentPaperOrientation
        Finds the current paper orientation.
        
        hwISession GetCurrentPaperSize
        Finds the current paper size.
        
        hwISession GetCurrentPrinter
        Finds the current printer.
        
        hwISession GetDataFileHandle
        Returns the data file interface object for a given file.
        
        hwISession GetError
        Returns a formatted error message if an error has occurred since the last call to *GetError(). *GetError() clears the error message after being called.
        
        hwISession GetExportMode
        Gets the export mode for the session.
        
        hwISession GetExternalReadersList
        Retrives a list of the names of all currently registered external readers.
        
        hwISession GetExternalSolvers
        Returns a Tcl list of registered external solvers of the form {name, path}.
        
        hwISession GetFontList
        Gets a list of all of the available fonts.
        
        hwISession GetGIFExportOptionsHandle
        Returns the GIF export options interface handle for the session.
        
        hwISession GetH3DExportOptionsHandle
        Obtain a handle to the session’s H3DExportOptions object.
        
        hwISession GetImportTemplatesList
        Retrieves a list of the names of all currently registered import templates.
        
        hwISession GetJPGExportOptionsHandle
        Obtain a handle to the session’s JPGExportOptions object.
        
        hwISession GetLibraryDirectorHandle
        Gets the library director handle.
        
        hwISession GetMemoryInfo
        Returns information on physical memory, virtual memory, and per process.
        
        hwISession GetMemoryUsage
        Returns memory usage in bytes (physical) and virtual.
        
        hwISession GetMenuControllerHandle
        Gets the menu controller handle.
        
        hwISession GetMessageLogHandle
        Gets the message log handle.
        
        hwISession GetNumberOfReportTemplates
        Finds the number of report templates in the session.
        
        hwISession GetPageHeight
        Finds the height of the main page client area.
        
        hwISession GetPageWidth
        Finds the width of the main page client area.
        
        hwISession GetPaperSizeList
        Returns a list of all the paper size options.
        
        hwISession GetPreferenceManagerHandle
        Gets the preference manager handle.
        
        hwISession GetPrinterList
        Returns a list of printers that are available for use.
        
        hwISession GetPrintRange
        Returns the range of pages to be printed.
        
        hwISession GetProjectHandle
        Returns the project interface object.
        
        hwISession GetRecordMode
        Returns the current recording mode.
        
        hwISession GetRecordState
        Returns the current recording status.
        
        hwISession GetReportList
        Retrieves a list of the names of all currently loaded report templates.
        
        hwISession GetReportTemplateHandle
        Gets the report template handle.
        
        hwISession GetSessionFileName
        Gets the session file name.
        
        hwISession GetSpaceballButtonMax
        Returns the highest Spaceball button ID that can be mapped to a Tcl callback via the RegisterSpaceballCallback procedure.
        
        hwISession GetSpaceballButtonMin
        Returns the highest Spaceball button ID that can be mapped to a Tcl callback via the RegisterSpaceballCallback procedure.
        
        hwISession GetSystemVariable
        Accesses application information.
        
        hwISession GetUserVariable
        Gets a meta data associated with the session level.
        
        hwISession GetXMLFileHandle
        Gets the XML file handle.
        
        hwISession GetXMLImageLinkMode
        Indicates whether the image links in the exported PowerPoint file have embedded or linked images.
        
        hwISession IsClientLoaded
        Indicates whether or not the specified client type is available in the current session.
        
        hwISession IsStandalone
        Checks if the application is running in standalone mode.
        
        hwISession LoadReport
        Loads the given report.
        
        hwISession LoadSessionFile
        Loads the given session file.
        
        hwISession New
        Creates a new project.
        
        hwISession PostMessageToLog
        Posts and displays the indicated message in the message log.
        
        hwISession Print
        Prints the current session.
        
        hwISession PerformBatchOperation
        Runs a Tcl/Tk script in a protected manner according to the specified execution mode.
        
        hwISession PublishSession
        Publishes the current session in either the HTML or XML format.
        
        hwISession RegisterExternalFunction
        Registers the given external function.
        
        hwISession RegisterExternalReader
        Registers the given external reader.
        
        hwISession RegisterExternalSolver
        Appends an external solver to the list of registered external solvers.
        
        hwISession RegisterImportTemplate
        Registers the given import template.
        
        hwISession RegisterSpaceballCallback
        Allows registration of Tcl callbacks for Spaceball button events.
        
        hwISession RegisterTemplexFunction
        Registers the given Templex function.
        
        hwISession RemovePrinter
        Removes a printer from the printer list.
        
        hwISession SaveReportTemplate
        Save the current session to a report template.
        
        hwISession SaveSessionFile
        Writes the session to the given filename.
        
        hwISession SetCurrentPaperOrientation
        Sets the current paper orientation.
        
        hwISession SetCurrentPaperSize
        Sets the current paper size.
        
        hwISession SetCurrentPrinter
        Sets the current printer.
        
        hwISession SetExportMode
        Sets the export mode for the page.
        
        hwISession SetPrintRange
        Sets the range of pages to be printed.
        
        hwISession SetSessionFileName
        Sets the session file name.
        
        hwISession SetUserVariable
        Associates a value to a variable on the session level.
        
        hwISession SetXMLImageLinkMode
        Sets whether the images in the exported PowerPoint file have embedded links.
        
        hwISession ShowWaitCursor
        Shows a wait mouse cursor in the application.
        
        hwISession UnloadXMLFile
        Unloads a previously loaded XML file, freeing the associated memory.
        
        hwISession UnregisterTemplexFunction
        Unregisters the given Templex function.
        
        hwISession CaptureWindow
        Creates an image file of a window on the current page.
        
        hwITemplex Class
        
        hwIViewControl Class
        
        hwIWindow Class
        
        hwIXMLFile Class
      - MotionView
      - HyperView
      - HyperGraph 2D
      - HyperGraph 3D
      - MediaView
      - TextView
      - HgTrans
      - TableView
  - 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.
  - HyperWorks Record and Playback
    Record playback workflows in HyperView.
- HyperWorks Report
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script Exchange
  The Script Exchange is a database of freely accessible scripts posted by users and Altair engineers.

View All Altair Simulation Help

HyperWorks Desktop

2021.1

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop 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 HyperWorks Desktop applications.
HyperWorks Desktop
hwISession Class
hwISession Close
Closes the session.

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

hwISession Close

Closes the session.

Syntax

hwISession_handle Close

Application

HyperWorks Tcl Query

Error

Success (0) or an error code.

(c) 2021. Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support