NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::ListingWindow Class Reference

Represents a ListingWindow. More...

List of all members.

Public Types

enum  DeviceType { DeviceTypeWindow, DeviceTypeFile, DeviceTypeFileAndWindow, DeviceTypeNone }
 Describes the type of listing window. More...

Public Member Functions

void Close ()
 Closes the stream to the listing window.
void CloseWindow ()
 Closes the listing window actually from the UI.
NXOpen::ListingWindow::DeviceType Device ()
 Returns the device type for the window.
bool IsOpen ()
 Returns a flag indicating whether the listing window is open.
void Open ()
 Opens the listing window.
void SelectDevice (NXOpen::ListingWindow::DeviceType deviceType, const NXString &fileName)
 Changes where the listing window output is sent.
tag_t Tag () const
 Returns the tag of this object.
void WriteLine (const NXString &msg)
 Writes a line to the listing window.

Detailed Description

Represents a ListingWindow.


To obtain an instance of this class, refer to Session

Created in NX3.0.0.


Member Enumeration Documentation

Describes the type of listing window.

Enumerator:
DeviceTypeWindow 

The UI's Information window.

DeviceTypeFile 

Output is written to a file instead of the Information window.

DeviceTypeFileAndWindow 

Output is written to a file and to the Information window.

DeviceTypeNone 

Output is not written anywhere; output gets discarded.


Member Function Documentation

Closes the stream to the listing window.

The window itself is not closed. If the listing window is a file, this will flush the buffer and close the file.
Created in NX3.0.0.

License requirements : None

Closes the listing window actually from the UI.


Created in NX6.0.0.

License requirements : None

Returns the device type for the window.

The device type indicates whether the output for the listing window is sent to the Information window, to a file, or to both
Created in NX3.0.0.

License requirements : None

Returns a flag indicating whether the listing window is open.

To open the window, use Open .
Created in NX3.0.0.

License requirements : None

Opens the listing window.

The listing window must be open before lines can be written to it
Created in NX3.0.0.

License requirements : None

Changes where the listing window output is sent.

The listing window output can be sent to the Information window of the Unigraphics session, to a file, or to both.

Note: file output is buffered. If file output is used, the buffer will not be flushed until the output device is changed again. E.g.

            ListingWindow.SelectDevice(File, "log.txt")
            ListingWindow.Open()
            ListingWindow.WriteLine("output")
            ListingWindow.Close()
            ' buffer is not flushed yet
            ListingWindow.SelectDevice(Window, "")
            ' now the buffer is flushed


Created in NX3.0.0.

License requirements : None

Parameters:
deviceTypeThe type of device (file, Information window, or both)
fileNameName of the file. Used only if the device type is file.
NOTE: The full Unicode character set is not supported for this parameter.
tag_t NXOpen::ListingWindow::Tag ( ) const

Returns the tag of this object.

Writes a line to the listing window.

The listing window must be open before you can write to it. If the listing window is a file, the output is buffered, so the output may not appear in the file until the buffer gets flushed. The buffer is flushed when the listing window gets closed.

If NULL is passed in this method will do nothing.


Created in NX3.0.0.

License requirements : None

Parameters:
msgLine to write
NOTE: The full Unicode character set is not supported for this parameter.

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.