All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Class CATBatchFrame

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---Dialog.CATDialog
            |
            +---Dialog.CATDlgBox
              |
              +---Dialog.CATDlgFrame
                |
                +---CATBatchFrame
 

Usage: you can derive this class.


public class CATBatchFrame

Base class to define the user interface of a specific batch.
Role: This class is used to define a user interface enabling the end-user input parameters for a batch.
Derive CATBatchFrame to create a class that will be instantiated by another dialog command in the batch monitor.

See also:
CATBatchParameters


Constructor and Destructor Index


o CATBatchFrame(CATDialog*,CATString&,CATDlgStyle)
Constructs a batch input frame.
o ~CATBatchFrame()

Method Index


o FillParametersFile(CATBatchParameters&,int&,void*)
Fills the parameters file through batch user interface.

Constructor and Destructor


o CATBatchFrame
protected CATBatchFrame(CATDialog* iParent,
const CATString& iDialogName,
CATDlgStyle iStyle)
Constructs a batch input frame.
Parameters:
iParent
The parent class in the Dialog aggregation hierarchy.
iDialogName
The dialog object name.
iStyle
A
CATDlgFrame style.
o ~CATBatchFrame
public virtual ~CATBatchFrame()

Methods


o FillParametersFile
public virtual HRESULT FillParametersFile(CATBatchParameters& iBatchParameters,
int& iReserved1,
void* iReserved2)=0
Fills the parameters file through batch user interface.
Parameters:
iBatchParameters
The batch parameters.
iReserved1
Reserved for future usage.
iReserved2
Reserved for future usage.
Returns:
Legal values:
S_OK : : on success i.e. all fields are correctly filled.
E_FAIL : : if one or more field(s) are not correctly filled.

This object is included in the file: CATBatchFrame.h
If needed, your Imakefile.mk should include the module: BatchMonitor

Copyright © 2003, Dassault Systèmes. All rights reserved.