SchSession (Object)

Methods

Sub CreateDocument( iDocType, iBInteractive, oNewDoc)

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.

Example:

 
 Dim objThisIntf As SchSession
 Dim strVar1 As String
 Dim bVar2 As boolean
 Dim objArg3 As Document
  ...
 objThisIntf.CreateDocumentstrVar1,bVar2,objArg3
 

Sub GetCurrentApplicationID( oApplicationID)

Get the current application ID.

Parameters:

oApplicationID

Application ID

Example:

 
 Dim objThisIntf As SchSession
 Dim strVar1 As String
  ...
 objThisIntf.GetCurrentApplicationIDstrVar1
 

Func GetCurrentDocument() As

Get the current document.

Parameters:

oCurDoc

Pointer to current document. DO NOT NEED TO RELEASE OUTPUT POINTER.

Example:

 
 Dim objThisIntf As SchSession
 Dim objArg1 As Document
  ...
 Set objArg1 = objThisIntf.GetCurrentDocument
 

Func GetSchExtContainer( iDoc) As

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

Example:

 
 Dim objThisIntf As SchSession
 Dim objArg1 As Document
 Dim objArg2 As AnyObject
  ...
 Set objArg2 = objThisIntf.GetSchExtContainer(objArg1)
 

Sub SetCurrentApplicationID( iApplicationID)

Set the current application ID.

Parameters:

iApplicationID

Application ID

Example:

 
 Dim objThisIntf As SchSession
 Dim strVar1 As String
  ...
 objThisIntf.SetCurrentApplicationIDstrVar1
 

Sub SetCurrentDocument( iCurDoc)

Set the current document.

Parameters:

iCurDoc

Pointer to current document.

Example:

 
 Dim objThisIntf As SchSession
 Dim objArg1 As Document
  ...
 objThisIntf.SetCurrentDocumentobjArg1