All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchAppCntrName

System.IUnknown
  |
  +---CATISchAppCntrName
 

Usage: you can reimplement this interface by deriving the supplied CATEASchAppCntrName adapter class.


interface CATISchAppCntrName

Interface to manage application connector name.
Applications must derive implementation of this interface from the adapter class CATEASchAppCntrName. Role: Defines application connector name.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o AppListNames(CATICStringList**)
o AppListNames2(CATListOfCATUnicodeString&)
List connector names allowed.
o GetName(char**)
o GetName2(CATUnicodeString&)
Get the application connector name.
o SetName(char*)
o SetName2(CATUnicodeString&)
Set the application connector name.

Methods


o AppListNames
public virtual HRESULT AppListNames(CATICStringList** oLConnectorNamesAllowed) = 0
Deprecated:
V5R15 Use CATISchAppCntrName.AppListNames2 instead. List connector names allowed.
Parameters:
oLConnectorNamesAllowed
A list of connector names allowed. The caller must allocate memory for the first level pointer (i.e. oLConnectorNamesAllowed) and release the second level pointer (i.e. *oLConnectorNamesAllowed) after usage.
o AppListNames2
public virtual HRESULT AppListNames2(CATListOfCATUnicodeString& oLConnectorNamesAllowed) = 0
List connector names allowed.
Parameters:
oLConnectorNamesAllowed
A list of connector names allowed.
o GetName
public virtual HRESULT GetName(char** oName) = 0
Deprecated:
V5R15 Use CATISchAppCntrName.GetName2 instead. Get the application connector name.
Parameters:
oName
The connector name. The caller must allocate memory for the first level pointer (i.e. oName) and release the second level pointer (i.e. *oName) after usage.
o GetName2
public virtual HRESULT GetName2(CATUnicodeString& oName) = 0
Get the application connector name.
Parameters:
oName
The connector name.
o SetName
public virtual HRESULT SetName( const char* iName) = 0
Deprecated:
V5R15 Use CATISchAppCntrName.SetName2 instead. Set the application connector name.
Parameters:
oName
The connector name.
o SetName2
public virtual HRESULT SetName2( const CATUnicodeString& iName) = 0
Set the application connector name.
Parameters:
oName
The connector name.

This object is included in the file: CATISchAppCntrName.h

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