CATPLMComponentInterfaces CATPLMSessionServices
Usage: you must use this class as is. You should never derive it.
public class CATPLMSessionServices
Class to create and delete a batch session.
Role: this class enables you to create and delete a batch PLM session.
These methods include the connection and the deconnection respectively.
Method Index
- o
ClosePLMSession()
- Closes the connection and delete the batch session.
- o
InitPLMSession()
- Creates a batch session and connects to a repository.
- o
SetPLMSessionParameter(CATUnicodeString&,CATUnicodeString&)
- Declares a connection parameter.
Methods
o ClosePLMSession
| public static ClosePLMSession( | ) |
-
Closes the connection and delete the batch session.
- Returns:
-
- S_OK if successfully done.
- E_FAIL if unexpected errors.
o InitPLMSession
| public static InitPLMSession( | ) |
-
Creates a batch session and connects to a repository.
- Returns:
-
- S_OK if succesfully connected.
- E_INVALIDARG in such cases :
- invalid connection parameters such as Repository not defined.
- E_FAIL if unexpected errors.
o SetPLMSessionParameter
| public static SetPLMSessionParameter( | const | iKey, |
| const | iValue) |
-
Declares a connection parameter.
These properties define the connection parameters to a repository.
They are :
- Repository : the repository name (like PLM1) which is mandatory.
- UserID : the user name for connection
- UserPasswd : the user password for connection
- SecurityCtx : the user security context server for connection
- Server : the URL string used for connection, expected format is 'protocol://ServerName:PortNumber/RootURI' .
This parameter will be automatically dispatched to the following parameters : ServerProtocol, ServerName,ServerPort,and ServerRootURI.
If you also set those parameters they will override the one from the 'Server' parameter.
It's not possible to give the user and password directly.
You can of course use subsets like Server:Port Server/RootURI protocol://Server etc...
- ServerName : the server name.
- ServerPort : the server port.
- ServerProtocole : the server protocole.
- ServerRootURI : the Root URI to use
A parameter must be declared only if its value is not null. The parameters definition order doesn't matter.
Some repository does not need all parameters for connection please check documentation of the repository.
- Parameters:
-
- iKey
- The parameter name
- iValue
- The value of the parameter
- Returns:
-
- S_OK if the property has been successfully added.
- E_INVALIDARG if the parameter name is invalid or if the length of iKey is null.
- E_FAIL otherwise if it has failed.
This object is included in the file: CATPLMSessionServices.h
If needed, your Imakefile.mk should include the module: CATPLMComponentInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.