Represents a ListingWindow. More...

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. More...

void	CloseWindow ()
	Closes the listing window actually from the UI. More...

NXOpen::ListingWindow::DeviceType	Device ()
	Returns the device type for the window. More...

bool	IsOpen ()
	Returns a flag indicating whether the listing window is open. More...

void	Open ()
	Opens the listing window. More...

void	SelectDevice (NXOpen::ListingWindow::DeviceType deviceType, const NXString &fileName)
	Changes where the listing window output is sent. More...

void	SelectDevice (NXOpen::ListingWindow::DeviceType deviceType, const char *fileName)
	Changes where the listing window output is sent. More...

tag_t	Tag () const
	Returns the tag of this object. More...

void	WriteFullline (const NXString &msg)
	Writes a full line to the listing window. More...

void	WriteFullline (const char *msg)
	Writes a full line to the listing window. More...

void	WriteLine (const NXString &msg)
	Writes a line to the listing window. More...

void	WriteLine (const char *msg)
	Writes a line to the listing window. More...

Detailed Description

Represents a ListingWindow.

To obtain an instance of this class, refer to NXOpen::Session

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::ListingWindow::DeviceType

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

void NXOpen::ListingWindow::Close ( )

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

void NXOpen::ListingWindow::CloseWindow ( )

Closes the listing window actually from the UI.

Created in NX6.0.0.

License requirements : None

NXOpen::ListingWindow::DeviceType NXOpen::ListingWindow::Device ( )

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

bool NXOpen::ListingWindow::IsOpen ( )

Returns a flag indicating whether the listing window is open.

To open the window, use NXOpen::Arc .
Created in NX3.0.0.

License requirements : None

void NXOpen::ListingWindow::Open ( )

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

void NXOpen::ListingWindow::SelectDevice	(	NXOpen::ListingWindow::DeviceType	deviceType,
		const NXString &	fileName
	)

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

deviceType	The type of device (file, Information window, or both)
fileName	Name of the file. Used only if the device type is file.

void NXOpen::ListingWindow::SelectDevice	(	NXOpen::ListingWindow::DeviceType	deviceType,
		const char *	fileName
	)

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

deviceType	The type of device (file, Information window, or both)
fileName	Name of the file. Used only if the device type is file.

tag_t NXOpen::ListingWindow::Tag ( ) const

Returns the tag of this object.

void NXOpen::ListingWindow::WriteFullline ( const NXString & msg )

Writes a full 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. And number of characters displayed in one line has no limit which is different from NXOpen::ListingWindow::WriteLine

If NULL is passed in this method will do nothing.

Created in NX8.5.0.

License requirements : None

Parameters

msg	Line to write

void NXOpen::ListingWindow::WriteFullline ( const char * msg )

Writes a full 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. And number of characters displayed in one line has no limit which is different from NXOpen::ListingWindow::WriteLine

If NULL is passed in this method will do nothing.

Created in NX8.5.0.

License requirements : None

Parameters

msg	Line to write

void NXOpen::ListingWindow::WriteLine ( const NXString & msg )

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. And the maximum number of characters displayed in one line is 132.

If NULL is passed in this method will do nothing.

Created in NX3.0.0.

License requirements : None

Parameters

msg	Line to write

void NXOpen::ListingWindow::WriteLine ( const char * msg )

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. And the maximum number of characters displayed in one line is 132.

If NULL is passed in this method will do nothing.

Created in NX3.0.0.

License requirements : None

Parameters

msg	Line to write

The documentation for this class was generated from the following file:

ListingWindow.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation