EngineStatus

EngineStatus

Top Previous Next

The EngineStatus property indicates the current status of the Engine.

Syntax

[VC++]

long GetEngineStatus();

[C#]

public abstract new eDocEngineX.TxgtEngineStatus EngineStatus [ get]

[VB]

Property EngineStatus As TxgtEngineStatus

Remarks

The EngineStatus property gives the current status of the Engine i.e., Engine in use. Following are the possible values for TxgtEngineStatus:

Engine Status	Description	Values
esNone	Initial State of the Engine	0
esStarted	If BeginDoc is invoked	1
esFinished	If document creation is finished	2
esError	If some error occurs while creation	3
esCancelled	If document creation is canceled	4

Example Code

[VC++]

m_Engine.SetFileName("Sample");

m_Engine.BeginDoc();

if(m_Engine.GetEngineStatus() != esStarted)

return;

m_Engine.EndDoc();

[VB]

With gtEngineX1

.FileName = "Sample"

.BeginDoc

If Not (.EngineStatus = esStarted) Then Exit Sub

.EndDoc

End With

[C#]

axgtEngineX1.FileName = "Sample";

axgtEngineX1.BeginDoc();

if (axgtEngineX1.EngineStatus != eDocEngineX.TxgtEngineStatus.esStarted)

Application.exit();

axgtEngineX1.EndDoc();