MFGS Session

MFGSSession Public interface

Description

Describes methods and properties available on the static instance object MFGS.Session

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExMFGSSession[[IExMFGSSession]]
  class VGWWCoreIEx.IExMFGSSession interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
bool	IsInDesigner Gets a value that indicates if the code is being executed in MFGStream Designer.	get
MFGSSessionType	Type Gets the type of session	get

Methods

Public methods

Returns	Name
void	SetState(object location, object comment) Used to set the text displayed in the ‘Step’, and optionally the ‘Comment’, columns of the Sessions grid in MFGStream Server.
void	Wait(int milliseconds) Causes the session to pause

Details

Summary

Describes methods and properties available on the static instance object MFGS.Session

Methods

SetState

public void SetState(object location, object comment)

Arguments

Type	Name	Description
object	location	The value to be displayed in the ‘Step’ column
object	comment	The value to be displayed in the ‘Comment’ column

Summary

Used to set the text displayed in the ‘Step’, and optionally the ‘Comment’, columns of the Sessions grid in MFGStream Server.

Remarks

The values displayed in the ‘Function’ and ‘Seq’ columns will also be update to the name of the WinWrap procedure calling this method and the line number in the associated code file

Wait

public void Wait(int milliseconds)

Arguments

Type	Name	Description
int	milliseconds	The number of milliseconds to wait

Summary

Causes the session to pause

Properties

IsInDesigner

public bool IsInDesigner { get; }

Summary

Gets a value that indicates if the code is being executed in MFGStream Designer.

Value

true if the code is being executed in MFGStream Designer; false if the code is being executed in MFGStream Server.

Type

public MFGSSessionType Type { get; }

Summary

Gets the type of session

Generated with ModularDoc