All Frameworks Class Hierarchy This Framework Next Indexes
ENOCESInterfaces Interface ENOVICESAuthentication
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVICESAuthentication
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVICESAuthentication
Interface to Login into CES
Role: ENOVICESAuthentication contains methods which are used to login into CES,checking for the connection and logout.
- Example:
- ENOVICESAuthentication_var piSysMyInterfaceOnComponent;
HRESULT rc = ::CATInstantiateComponent( "ENOVCESAuthenticationImpl",
IID_ENOVICESAuthentication,
(void**)&piSysMyInterfaceOnComponent);
Method Index
- o
IsConnected()
- IsConnected: Checks if the connection to CES is still valid.
- o
Login(CATUnicodeString,CATUnicodeString,CATUnicodeString,CATUnicodeString)
- Login: Connects the CES Server and creates a session context, database connection.
- o
Logout()
- Logout: Disconnects the existing database connection and invalidates the session in the CES Server.
Methods
o IsConnected
public virtual HRESULT IsConnected( | )=0 |
-
IsConnected: Checks if the connection to CES is still valid.
This method returns E_FAIL If NO connection exists. Returns S_OK if connection is still valid.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Connection is valid
- E_FAIL
- Not Connected
o Login
-
Login: Connects the CES Server and creates a session context, database connection.
This will initialize the environment for invoking CATJWSInfra webervice call.
LCA Nav Server has to be running before this call can be executed.
- Parameters:
-
- iUserName
- Specifies the username for the CES db connection.
- iPassword
- Specifies the password for the CES db connection.
- iDBName
- Specifies the CESDatabase name to create the connection.
- iServerURL
- The Server URL on which LCANav Server or CATJWSInfra server is active.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Connection made successful
- E_FAIL
- Login is not successful
o Logout
-
Logout: Disconnects the existing database connection and invalidates the session in the CES Server.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Logout is successful
- E_FAIL
- Logout is not successful
This object is included in the file: ENOVICESAuthentication.h
If needed, your Imakefile.mk should include the module: ENOVCESPartSelectionApi