All Frameworks  Object Hierarchy  This Framework  Indexes

SchAppCntrDocLink (Object)

Manage a schematic connector.

Method Index

AppGetLink
AppGetLinkedDocs
Get a list of linked connectors, their documents' names, uuids, and 'open in session' statuses, and a publication name of the connectors.
AppIsLinkable
Query whether this connector and input connector can be linked.
AppLinkInit
Publish this connector to make it available for linking.
AppLink
Create an external link to another connector.
AppOpenLinkedDoc
Open a linked document.
AppUnLink
Remove external link to another connector.

Methods


o Sub AppGetLink( oLCntrs,
oLDocumentNames,
oPublicationName)
Deprecated:
V5R18 Use SchAppCntrDocLink.AppGetLinkedDocs instead. Get a list of linked connector(s) and its document names or publication name.
Parameters:
oLCntrs
A list of connectors that are linked to this connector.
oLDocumentNames
A list of document names containing the linked connector.
oPublicationName
The publication name of the connector(s) linked to this connector.
Example: 
 Dim objThisIntf As SchAppCntrDocLink
 Dim objArg1 As SchListOfObjects
 Dim objArg2 As SchListOfBSTRs
 Dim strVar3 As String
  ...
 objThisIntf.AppGetLinkobjArg1,objArg2,strVar3
o Sub AppGetLinkedDocs( oPublicationName,
oLDocumentName,
oLDocumentUuid,
oLOpenStatus,
oLCntr)
Get a list of linked connectors, their documents' names, uuids, and 'open in session' statuses, and a publication name of the connectors.
Parameters:
oPublicationName
The publication name of the connector(s) linked to this connector.
oLDocumentName
A list of document names of the documents containing the linked connector(s).
oLDocumentUuid
A list of document UUIDs of the documents containing the linked connector(s).
oLOpenStatus
A list of integer flags specifying whether a linked document is open in the session or not (1 - yes; 0 - no).
oLCntr
A list of connectors that are linked to this connector.
Example: 
 Dim objThisIntf As SchAppCntrDocLink
 Dim strVar1 As String
 Dim objArg2 As SchListOfBSTRs
 Dim objArg3 As SchListOfBSTRs
 Dim objArg4 As SchListOfLongs
 Dim objArg5 As SchListOfObjects
  ...
 objThisIntf.AppGetLinkedDocsstrVar1,objArg2,objArg3,objArg4,objArg5
o Sub AppIsLinkable( iSchConnector,
oBYes)
Query whether this connector and input connector can be linked.
Parameters:
iSchConnector
The connector to link to.
oBYes
If TRUE, connectors can be linked.
Example: 
 Dim objThisIntf As SchAppCntrDocLink
 Dim objArg1 As SchAppConnector
 Dim bVar2 As boolean
  ...
 objThisIntf.AppIsLinkableobjArg1,bVar2
o Sub AppLinkInit( iPublicationName)
Publish this connector to make it available for linking.
Parameters:
iPublicationName
The publication name of connector.
Example: 
 Dim objThisIntf As SchAppCntrDocLink
 Dim strVar1 As String
  ...
 objThisIntf.AppLinkInitstrVar1
o Sub AppLink( iSchConnector)
Create an external link to another connector.
Parameters:
iSchConnector
The connector to link to.
Example: 
 Dim objThisIntf As SchAppCntrDocLink
 Dim objArg1 As SchAppConnector
  ...
 objThisIntf.AppLinkobjArg1
o Sub AppOpenLinkedDoc( iDocumentName,
iDocumentUuid,
oDocument)
Open a linked document.
Parameters:
iDocumentName
Name of the document (from oLDocumentName list in AppGetLinkedDocs).
iDocumentUuid
Uuid of the document (from oLDocumentUuid list in AppGetLinkedDocs).
oDocument
Pointer to the document.
Example: 
 Dim objThisIntf As SchAppCntrDocLink
 Dim strVar1 As String
 Dim strVar2 As String
 Dim objArg3 As Document
  ...
 objThisIntf.AppOpenLinkedDocstrVar1,strVar2,objArg3
o Sub AppUnLink( iUnpublish)
Remove external link to another connector.
Parameters:
iUnpublish
iUnpublish = 0, do not delete publication connector (default) iUnpublish > 0, delete publication connector
Example: 
 Dim objThisIntf As SchAppCntrDocLink
 Dim intVar1 As Integer
  ...
 objThisIntf.AppUnLinkintVar1

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