PLMSessionInterfaces PLMPSISessionHelpers
Usage: you must use this class as is. You should never derive it.
public class PLMPSISessionHelpers
Class managing session data for the creation of PLM entities.
Role: This class allows to manage some session information like the current environment (
Method Index
- o
GetCurrentEnvironment(CATIAdpEnvironment*&)
- Computes the current environment of the session.
- o
GetSessionHelpers(PLMPSISessionHelpers*&)
- Retrieves the Session Helpers.
- o
SetCurrentEnvironment(CATString&)
- Sets the current environment of the session.
Methods
o GetCurrentEnvironment
| public GetCurrentEnvironment( | | oEnv) |
-
Computes the current environment of the session.
- Parameters:
-
- oEnv
- [out, CATBaseUnknown#Release] The current environment of the session.
Note: the pointer must be RELEASED.
- Returns:
-
- E_FAIL if an error occurred
- S_OK if the environment is valuated
o GetSessionHelpers
| public static GetSessionHelpers( | | opSessionHelper) |
-
Retrieves the Session Helpers.
- Parameters:
-
- opSessionHelper
- The returned session helpers.
Note: Do not release the returned singleton.
- Returns:
-
- E_FAIL if an error occurred
- S_OK if the Session Helpers are returned
o SetCurrentEnvironment
| public SetCurrentEnvironment( | const | iEnvId) |
-
Sets the current environment of the session.
This method does not load the environment. Loading is done only when necessary.
- Parameters:
-
- iEnvId
- The environment identifier to be set.
- Returns:
-
- E_INVALIDARG if the environment is not supported by the session
- E_FAIL if an error occurred
- S_OK the environment is successfully set
This object is included in the file: PLMPSISessionHelpers.h
If needed, your Imakefile.mk should include the module: PLMPSISessionInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.