All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchSession
System.IUnknown
|
+---CATISchSession
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchSession
Interface to manage document sessions with Schematic context.
Role: To create schematic documents.
Method Index
- o
CreateDocument(char*,CATBoolean,CATDocument**)
- Create a document with Schematic context.
- o
GetCurrentApplicationID(char**)
- Get the current application ID.
- o
GetCurrentDocument(CATDocument*&)
- Get the current document.
- o
GetSchExtContainer(CATDocument*,IUnknown**)
- Get the schematic container (e.
- o
GetSchObjInterface(CATClassId,IID&,void**)
- Get the specified interface for the requested object.
- o
SetCurrentApplicationID(char*)
- Set the current application ID.
- o
SetCurrentDocument(CATDocument*)
- Set the current document.
Methods
o CreateDocument
-
Create a document with Schematic context.
- Parameters:
-
- iDocType
- Document type, if NULL "Product" is assumed. These are the types
shown in the File+New list
- iBInteractive
- If TRUE, document is created in interactive session with editor
- oNewDoc
- Document created. DO NOT NEED TO RELEASE OUTPUT POINTER.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetCurrentApplicationID
public virtual HRESULT GetCurrentApplicationID( | char** | oApplicationID) = 0 |
-
Get the current application ID.
- Parameters:
-
- oApplicationID
- Application ID
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetCurrentDocument
-
Get the current document.
- Parameters:
-
- oCurDoc
- Pointer to current document. DO NOT NEED TO RELEASE OUTPUT POINTER.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetSchExtContainer
-
Get the schematic container (e.g. for CATISchBaseFactory implementation).
- Parameters:
-
- iDoc
- Document in the session to retreive the container from
- oContainer
- Schematic container
shown in the File+New list
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetSchObjInterface
public virtual HRESULT GetSchObjInterface( | CATClassId | type, |
| const IID& | iIID, |
| void** | oIntf) = 0 |
-
Get the specified interface for the requested object.
- Parameters:
-
- type
- Object name
- iIID
- Interface identifier.
- oIntf
- Interface pointer
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetCurrentApplicationID
public virtual HRESULT SetCurrentApplicationID( | const char* | iApplicationID) = 0 |
-
Set the current application ID.
- Parameters:
-
- iApplicationID
- Application ID
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetCurrentDocument
-
Set the current document.
- Parameters:
-
- iCurDoc
- Pointer to current document.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchSession.h