All Frameworks Class Hierarchy This Framework Indexes
CATSchPlatformInterfaces Class CATEASchAppObjectFactory2
Usage: you can derive this class.
public class CATEASchAppObjectFactory2
Super class to derive implementation for interface CATISchAppObjectFactory2.
Role: Adaptor
Constructor and Destructor Index
- o
CATEASchAppObjectFactory2()
- Constructs an empty CATEASchAppObjectFactory2.
- o
~CATEASchAppObjectFactory2()
-
Method Index
- o
AppCreateCompRef(char*,CATDocument*,IUnknown**)
- Create an Application Component reference.
- o
AppCreateCompRef(char*,IUnknown**)
-
- o
AppCreateConnection(char*,CATDocument*,IUnknown**)
- Create an Application Connection object.
- o
AppCreateConnection(char*,IUnknown**)
-
- o
AppCreateGroup(char*,CATDocument*,IUnknown**)
- Create an Application Group object.
- o
AppCreateGroup(char*,IUnknown**)
-
- o
AppCreateRoute2(char*,CATDocument*,CATUnicodeString*,IUnknown**)
- Create an Application Route object.
- o
AppCreateRouteFromRef2(CATISchAppRoute*,CATDocument*,CATUnicodeString*,IUnknown**)
- Create an Application Route object with a specific reference.
- o
AppCreateRouteFromRef(CATISchAppRoute*,IUnknown**,char*)
-
- o
AppCreateRouteFromRef(CATISchAppRoute*,CATDocument*,char*,IUnknown**)
-
- o
AppCreateRouteWithInfo(char*,IUnknown*,IUnknown**)
- Create an Application Route object with application information.
- o
AppCreateRoute(char*,CATDocument*,char*,IUnknown**)
-
- o
AppCreateRoute(char*,IUnknown**,char*)
-
- o
AppCreateZone(char*,CATDocument*,IUnknown**)
- Create an Application Zone object.
- o
AppCreateZone(char*,IUnknown**)
-
Constructor and Destructor
o CATEASchAppObjectFactory2
| public CATEASchAppObjectFactory2( | ) |
-
Constructs an empty CATEASchAppObjectFactory2.
o ~CATEASchAppObjectFactory2
| public virtual ~CATEASchAppObjectFactory2( | ) |
-
Methods
o AppCreateCompRef
| public virtual AppCreateCompRef( | const | iAppCompClassType, |
| const | iDoc, |
| | oAppComp) |
-
Create an Application Component reference.
- Parameters:
-
- iAppCompClassType
- Class type of the Application Component reference.
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- oAppComp
- The new Application Component object created (CATISchAppComponent
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateCompRef
| public virtual AppCreateCompRef( | const | iAppCompClassType, |
| | oAppComp) |
-
- Deprecated:
- V5R15
Do not override or use this method.
Create an Application Component reference.
- Parameters:
-
- iAppCompClassType
- Class type of the Application Component reference.
- oAppComp
- The new Application Component object created (CATISchAppComponent
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateConnection
| public virtual AppCreateConnection( | const | iAppCntnClassType, |
| const | iDoc, |
| | oAppConnection) |
-
Create an Application Connection object.
- Parameters:
-
- iAppCntnClassType
- Class type of the Application Connection object.
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- oAppConnection
- The new Application Connection object created (CATISchAppConnection
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateConnection
| public virtual AppCreateConnection( | const | iAppCntnClassType, |
| | oAppConnection) |
-
- Deprecated:
- V5R15
Do not override or use this method.
Create an Application Connection object.
- Parameters:
-
- iAppCntnClassType
- Class type of the Application Connection object.
- oAppConnection
- The new Application Connection object created (CATISchAppConnection
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateGroup
| public virtual AppCreateGroup( | const | iAppGroupClassType, |
| const | iDoc, |
| | oAppGroup) |
-
Create an Application Group object.
- Parameters:
-
- iAppGroupClassType
- Class type of the Application Group object.
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- oAppGroup
- The new Application Group object created (CATISchAppGroup
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateGroup
| public virtual AppCreateGroup( | const | iAppGroupClassType, |
| | oAppGroup) |
-
- Deprecated:
- V5R15
Do not override or use this method.
Create an Application Group object.
- Parameters:
-
- iAppGroupClassType
- Class type of the Application Group object.
- oAppGroup
- The new Application Group object created (CATISchAppGroup
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateRoute2
| public virtual AppCreateRoute2( | const | iAppRouteClassType, |
| const | iDoc, |
| const | iLogLineID, |
| | oAppRoute) |
-
Create an Application Route object.
- Parameters:
-
- iAppRouteClassType
- Class type of the Application Route object.
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- iLogLineID
- The logical line ID that will contain the new route.
This is an optional input. If could be NULL.
- oAppRoute
- The new Application Route object created (CATISchAppRoute
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateRouteFromRef2
| public virtual AppCreateRouteFromRef2( | | iRouteReference, |
| const | iDoc, |
| const | iLogLineID, |
| | oAppRoute) |
-
Create an Application Route object with a specific reference.
- Parameters:
-
- iAppRouteRef
- Route reference to creaet the output route from
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- iLogLineID
- The logical line ID that will contain the new route.
This is an optional input. If could be NULL.
- oAppRoute
- The new Application Route object created (CATISchAppRoute
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateRouteFromRef
| public virtual AppCreateRouteFromRef( | | iRouteReference, |
| | oAppRoute, |
| const | iLogLineID | =NULL) |
-
- Deprecated:
- V5R15
Do not override or use this method.
Create an Application Route object with a specific reference.
- Parameters:
-
- iAppRouteRef
- Route reference to creaet the output route from
- oAppRoute
- The new Application Route object created (CATISchAppRoute
interface pointer).
- iLogLineID
- The logical line ID that will contain the new route.
This is an optional input.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateRouteFromRef
| public virtual AppCreateRouteFromRef( | | iRouteReference, |
| const | iDoc, |
| const | iLogLineID, |
| | oAppRoute) |
-
- Deprecated:
- V5R15
Use
CATEASchAppObjectFactory2.AppCreateRouteFromRef2 instead. Create an Application Route object with a specific reference.
- Parameters:
-
- iAppRouteRef
- Route reference to creaet the output route from
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- iLogLineID
- The logical line ID that will contain the new route.
This is an optional input. If could be NULL.
- oAppRoute
- The new Application Route object created (CATISchAppRoute
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateRouteWithInfo
| public virtual AppCreateRouteWithInfo( | const | iAppRouteClassType, |
| | iAppInfo, |
| | oAppRoute) |
-
Create an Application Route object with application information.
- Parameters:
-
- iAppRouteClassType
- Class type of the Application Route object.
- iAppInfo
- Application data pointer
- oAppRoute
- The new Application Route object created (CATISchAppRoute
interface pointer).
o AppCreateRoute
| public virtual AppCreateRoute( | const | iAppRouteClassType, |
| const | iDoc, |
| const | iLogLineID, |
| | oAppRoute) |
-
- Deprecated:
- V5R15
Use
CATEASchAppObjectFactory2.AppCreateRoute2 instead. Create an Application Route object.
- Parameters:
-
- iAppRouteClassType
- Class type of the Application Route object.
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- iLogLineID
- The logical line ID that will contain the new route.
This is an optional input. If could be NULL.
- oAppRoute
- The new Application Route object created (CATISchAppRoute
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateRoute
| public virtual AppCreateRoute( | const | iAppRouteClassType, |
| | oAppRoute, |
| const | iLogLineID | =NULL) |
-
- Deprecated:
- V5R15
Do not override or use this method.
Create an Application Route object.
- Parameters:
-
- iAppRouteClassType
- Class type of the Application Route object.
- oAppRoute
- The new Application Route object created (CATISchAppRoute
interface pointer).
- iLogLineID
- The logical line ID that will contain the new route.
This is an optional input.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateZone
| public virtual AppCreateZone( | const | iAppZoneClassType, |
| const | iDoc, |
| | oAppZone) |
-
Create an Application Zone object.
- Parameters:
-
- iAppZoneClassType
- Class type of the Application Zone object.
- iDoc
- Pointer to a document to create the object in. If NULL, the
document associated with the current Editor will be used.
- oAppZone
- The new Application Zone object created (CATISchAppZone
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AppCreateZone
| public virtual AppCreateZone( | const | iAppZoneClassType, |
| | oAppZone) |
-
- Deprecated:
- V5R15
Do not override or use this method.
Create an Application Zone object.
- Parameters:
-
- iAppZoneClassType
- Class type of the Application Zone object.
- oAppZone
- The new Application Zone object created (CATISchAppZone
interface pointer).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATEASchAppObjectFactory2.h
If needed, your Imakefile.mk should include the module: CATSchItfCPP