All Frameworks  Class Hierarchy  This Framework  Next  Indexes

VPMXBom Interface ENOVIApplication

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ENOVIApplication
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface ENOVIApplication

Interface representing the ENOVIA application server.
Role: Represent the ENOVIA application, to support secured multiuser mode this is the only interface which may be shared by different users. it is used to gain access to a login session. The application will check the list of running session to verify if a session needs to be restored (because of client disfunctionment or different client application using the same session). If none exist, a new session is created and returned.
Design Pattern: the object which implements this interface follows the singleton design pattern, this is insured by giving ENOVGetApplication as the sole mean to get an object implementing this interface.


Method Index


o get_Login(ENOVILoginSession**)
Retrieves the default login session based on the connected user.
o login(char*,char*,char*,int&,ENOVILoginSession**)
Retrieves a login session based on the argument passed.

Methods


o get_Login
public virtual HRESULT __stdcall get_Login(ENOVILoginSession** oLogin)=0
Retrieves the default login session based on the connected user.
Role: when the ENOVIA server is running in a single user configuration, this is used to benefit from the Security check done by the system, the user logged in the ENOVIA server is the user which owns the process.
Precondition: oLogin is a valid pointer.
Parameters:
oLogin
address of the pointer to the Login Session.
Returns:
An HRESULT value.
Legal values:
S_OK
All went well and the interface pointer is successfully returned
S_FALSE
Impossible to get the default login session a full login needs to be done
E_POINTER
The oLogin pointer was NULL
E_FAIL
Unknown internal error
All other possible IUnknown.QueryInterface return code
A query interface failed
o login
public virtual HRESULT __stdcall login( const char* iUserId,
const char* iPassword,
const char* iRole,
const int& iNetWorkMode,
ENOVILoginSession** oLogin)=0
Retrieves a login session based on the argument passed.
Role: when the ENOVIA server is running in a multi user configuration, or in a batch process this is used to get the login Session corresponding to the input parameters or to create one if none exist.
Precondition: oLogin is a valid pointer.
Parameters:
iUserId
id of the user
iPassword
password of the user
iRole
role of the user
iNetWorkMode
type of network communication
Legal values: 0 local session no communication bus will be created, 1 distributed session a communication bus will be created
oLogin
address of the pointer to the Login Session.
Returns:
An HRESULT value.
Legal values:
S_OK
All went well and the interface pointer is successfully returned
E_POINTER
The oLogin pointer was NULL
E_FAIL
Unknown internal error
All other possible IUnknown.QueryInterface return code
A query interface failed

This object is included in the file: ENOVIApplication.h
If needed, your Imakefile.mk should include the module: VPMXbmItf

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