All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchAppConnectable
System.IUnknown
|
+---CATISchAppConnectable
Usage: you can freely reimplement this interface.
interface CATISchAppConnectable
Interface to mangage application object behaviors in making connections.
Role: To specify application object behaviors such as
adding a connector and removing a connector.
Method Index
- o
AppAddConnector(char*,CATISchAppConnector**)
- Add a connector.
- o
AppGetReferenceName(char**)
- Get the reference name of a connectable.
- o
AppListConnectables(CATICStringList*,CATIUnknownList**,CATIUnknownList**,CATIUnknownList**)
- Find all the application objects connected to this object through
their connectors.
- o
AppListConnectors(CATICStringList*,CATIUnknownList**)
- Find all the connectors of this application object.
- o
AppListValidCntrTypes(CATICStringList**)
- List the valid application connector types allowed to be created.
- o
AppRemoveConnector(CATISchAppConnector*)
- Remove a connector.
- o
AppSetReferenceName(char*)
- Set the reference name of a connectable.
Methods
o AppAddConnector
-
Add a connector.
- Parameters:
-
- iClassType
- Class type of the connector to be added.
- oNewAppCntr
- The new Application Connector object created.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppGetReferenceName
public virtual HRESULT AppGetReferenceName( | char** | oReferenceName) = 0 |
-
Get the reference name of a connectable. It will be displayed in catalogs.
- Parameters:
-
- oReferenceName
- The name of the reference
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppListConnectables
-
Find all the application objects connected to this object through
their connectors.
- Parameters:
-
- oLCntrClassFilter
- A list of all the class types for filtering the output application
objects list.
- oLCntbles
- A list of application objects connected to this object.
(members are CATISchAppConnectable interface pointers).
- oLCntrsOnThisObj
- A list of connectors on this object through which
the connection is made.
(members are CATISchAppConnector interface pointers).
- oLCntrsOnConnected
- A list of connectors on the connected objects through which
the connection is made.
(members are CATISchAppConnector interface pointers).
Members in this list corresponds to those in oLCntrsOnThisObj in
making the corresponding connections.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppListConnectors
-
Find all the connectors of this application object.
- Parameters:
-
- oLCntrClassFilter
- A list of all the class types for filtering the output connector
list.
- oLCntrs
- A list of connectors included in this connection.
(members are CATISchAppConnector interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppListValidCntrTypes
-
List the valid application connector types allowed to be created.
- Parameters:
-
- oLValidCntrTypes
- A list of connector class types allowed.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppRemoveConnector
-
Remove a connector.
- Parameters:
-
- iCntrToRemove
- The application connector object to be removed
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppSetReferenceName
public virtual HRESULT AppSetReferenceName( | const char* | iReferenceName) = 0 |
-
Set the reference name of a connectable. It will be displayed in catalogs.
- Parameters:
-
- iReferenceName
- The name of the reference
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchAppConnectable.h