All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATIScriptManager

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIScriptManager
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIScriptManager

Interface to represent the manager of macros generation.
Role: CATScriptManager is the high level object used to trigger user interaction recording and script generation in various scripting syntaxes.

See also:
CATIScriptJournal, CATScriptLanguage


Method Index


o GenerateResolutionScriptOfObject(CATBaseDispatch*,CATScriptLanguage,CATUnicodeString&)
Generates the script representing the resolution of an automation object in the specified language.
o GenerateScript(CATScriptLanguage,CATString&,iostream*)
Generates a script.
o GetJournal(CATIScriptJournal*&)
Returns the journal used for internal storage.
o IsRecording(CATBoolean&)
Returns TRUE if the Script Manager is recording, FALSE otherwise.
o Reset()
Flushes the journal used for internal storage.
o ResumeRecording()
Resumes the recording halted by SuspendRecording.
o StartRecording()
Starts recording.
o StopRecording()
Stops recording.
o SuspendRecording()
Temporarily suspends the recording.

Methods


o GenerateResolutionScriptOfObject
public virtual HRESULT GenerateResolutionScriptOfObject(CATBaseDispatch* iObject,
CATScriptLanguage iLanguage,
CATUnicodeString& ioScript) = 0
Generates the script representing the resolution of an automation object in the specified language.
Parameters:
iObject
The automation object to resolve.
iLanguage
The specified language of the generated script.
ioScript
The supplied CATUnicodeString in which the script will be written.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o GenerateScript
public virtual HRESULT GenerateScript(CATScriptLanguage iLanguage,
const CATString& iMainMethodName,
iostream* ioStream) = 0
Generates a script.
Role: Use this method to write a script in the proper syntax of the specified language with the given method name and write it to the supplied stream.
Parameters:
iLanguage
The specified language of the generated script.
iMainMethodName
The main method name that can be used later as the entry point of the script.
ioStream
The supplied stream in which the script will be generated.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o GetJournal
public virtual HRESULT GetJournal(CATIScriptJournal*& oJournal) = 0
Returns the journal used for internal storage.
Returns an error if the script manager is not recording.
Parameters:
oJournal
The returned journal.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o IsRecording
public virtual HRESULT IsRecording(CATBoolean& oIsRecording) = 0
Returns TRUE if the Script Manager is recording, FALSE otherwise.
Parameters:
oIsRecording
The returned boolean descripting the state of the script manager.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o Reset
public virtual HRESULT Reset()= 0
Flushes the journal used for internal storage.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o ResumeRecording
public virtual HRESULT ResumeRecording()= 0
Resumes the recording halted by SuspendRecording.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o StartRecording
public virtual HRESULT StartRecording()= 0
Starts recording.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o StopRecording
public virtual HRESULT StopRecording()= 0
Stops recording.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.
o SuspendRecording
public virtual HRESULT SuspendRecording()= 0
Temporarily suspends the recording.
Role: Use this function when you want to inhibit macro generation for Automation API calls which would normally result in declarations in the journal. SuspendRecording can be called several times in a row. If such is the case, the same number of calls to ResumeRecording must be done before the macro generationa actually resumes. This method must be called only after the call to StartRecording has been made.
Returns:
S_OK if the operation succeeded, E_FAIL otherwise.

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

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