All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

CATxPDMInterfaces Class CATxPDMSessionUIServices

CATxPDMSessionUIServices
 

Usage: you must use this class as is. You should never derive it.


public class CATxPDMSessionUIServices

Class for PDM to manage interactive feedbacks of PDM in CATIA Session.

All the methods pre-requisites the PX1 license

See also:
CATIxPDMItem, CATIxPDMSessionServices


Method Index


o ConnectToPX1()
Activate all PX1 interactive feedbacks.
o ConnectToPX1(char*)
Activate all PX1 interactive feedbacks.
o DisconnectFromPX1()
Disconnect from PX1.
o DisconnectFromPX1(char*)
Disconnect from PX1.
o GetCurrentDirectory(CATUnicodeString&)
Retrieve current directory.

Methods


o ConnectToPX1
public static HRESULT ConnectToPX1()
Activate all PX1 interactive feedbacks.
Role:This method activates PX1 interactive feedbacks. After connection, a specific icon will be automatically added on all item with Read-Only status on disk. When you check-out or check-in a file, you have to update its read-write status on disk and to call CATxPDMSessionServices#RefreshItemInformation to update interactive display. You have to call this method when you connect to your PDM.
Returns:
  • S_OK: Connection successfull.
  • S_FALSE: Already connected.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1001:
    • The PX1 licence is not available.
o ConnectToPX1
public static HRESULT ConnectToPX1( const char* iPX1SessionIdentifier)
Activate all PX1 interactive feedbacks.
Role:This method activates PX1 interactive feedbacks. After connection, a specific icon will be automatically added on all item with Read-Only status on disk. When you check-out or check-in a file, you have to update its read-write status on disk and to call CATxPDMSessionServices#RefreshItemInformation to update interactive display. You have to call this method when you connect to your PDM.
Parameters:
iPX1SessionIdentifier
This parameter is necessary to support several connection from different PDMs at same time. PX1 will be effectively disconnected only when all PDMs are disconnected. Same identifier should be used for connect and disconnect.
Returns:
  • S_OK: Connection successfull.
  • S_FALSE: Already connected.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1001:
    • The PX1 licence is not available.
o DisconnectFromPX1
public static HRESULT DisconnectFromPX1()
Disconnect from PX1.
Role:This method disconnect from PX1 interactive feedbacks. All specific icons are removed. You have to call this method when you disconnect from your PDM.
Returns:
  • S_OK: Disconnect successfull.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1001:
    • The PX1 licence is not available.
o DisconnectFromPX1
public static HRESULT DisconnectFromPX1( const char* iPX1SessionIdentifier)
Disconnect from PX1.
Role:This method disconnect from PX1 interactive feedbacks. All specific icons are removed. You have to call this method when you disconnect from your PDM.
Parameters:
iPX1SessionIdentifier
This parameter is necessary to support several connection from different PDMs at same time. PX1 will be effectively disconnected only when all PDMs are disconnected. Same identifier should be used for connect and disconnect.
Returns:
  • S_OK: Disconnect successfull.
  • S_FALSE: Disconnect successfull but still connected by another PDM.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1001:
    • The PX1 licence is not available.
o GetCurrentDirectory
public static HRESULT GetCurrentDirectory(CATUnicodeString& oCurrentDirectory)
Retrieve current directory.
Role:This method retrieve current directory : last directory used for file operations like Open or Save. This method should be used if you want to initialize your panel with same directory than standard interactive Open and Save commands. Notice that this directory is only an interactive default, it does not mean that all file will be opened or saved in this directory. This directory could be null if no file selection has been performed in session.
Parameters:
oCurrentDirectory
The current directory used in interactive file selection box.
Returns:
  • S_OK: Directory successfully returned.
  • E_FAIL: Impossible to retrieve the directory:

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

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