All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPDMBaseInterfaces Interface CATIPDMUEReadMode

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

Usage: you can freely reimplement this interface.


interface CATIPDMUEReadMode

Interface to enable to change the read/write status of a document loaded from VPM.
Role: This interface is a user exit, that allows to change the read/write status of a document loaded from VPM.
You should implement it on the CATUEPDMReadMode component by using the CATObject mechanism.


Method Index


o IsToSetReadOnly(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATBoolean&)
Allows to change the status of a document load from PDM.

Methods


o IsToSetReadOnly
public virtual HRESULT IsToSetReadOnly( const CATUnicodeString& iCoid,
const CATUnicodeString& iCompid,
const CATUnicodeString& iCaenv,
const CATUnicodeString& iCatab,
const CATUnicodeString& iServer,
CATBoolean& oIsToSetReadOnly)=0
Allows to change the status of a document load from PDM.
Parameters:
iCoid
Coid of the document
iCompid
Compid of the document
iCaenv
Environment of the document
iCatab
Table of the document
iServer
Server in which the document is stored
oIsToSetReadOnly
Output value : - TRUE if the user wants to set the document readonly - FALSE if the user wants to set the document read/write
Returns:
HRESULT Error code of function. S_OK : The change mode of the document worked E_FAIL : The chang mode of the document didn't work

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

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