All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATIUExitIO

System.IUnknown
  |
  +---CATIUExitIO
 

Usage: you can freely reimplement this interface.


interface CATIUExitIO

Interface to enable some user specific manipulations on the files.
Role: This interface is a user exit, that allows an user to perform some specific operations in order to control the opening, the closing and the creation of the files
You should implement it on the CATUExitIO component by creating a data extension.


Method Index


o CreationMask(CATUnicodeString*,DWORD*,CATFileSystemError*)
Allows the user to set a creation mask.
o OnClose(CATUnicodeString*,CATFileSystemError*)
Allows the user to process some operations on the file to close.
o OnOpen(CATUnicodeString*,CATAccessRight,HRESULT*,CATFileSystemError*)
Allows the user to perform some operations on the file to open.

Methods


o CreationMask
public virtual HRESULT CreationMask( const CATUnicodeString* iFileName,
DWORD* oMode,
CATFileSystemError* oError)=0
Allows the user to set a creation mask.
Role: This method allows the user to set a specific creation mask for the file to be created, for example the right of the current directory.
Parameters:
iFileName
The filename to create.
oMode
The desired mask to be used for the file creation.
oError
The system error that has occured in case of failure, valuated with CATERRNO
Returns:

S_OK ,If no problem has occured during the processing and oMode is valuated.
E_NOTIMPL , The method is not implemented.
E_FAIL If any problem has occured. In this cas the method must set oError with CATERRNO
o OnClose
public virtual HRESULT OnClose( const CATUnicodeString* iFileName,
CATFileSystemError* oError)=0
Allows the user to process some operations on the file to close.
Role: This method allows the user to perform same operations on the file that has just been closed. It's the reverse methode of OnOpen. right of the current user.
Parameters:
iFileName
The name of the closed file .
oError
The system error that has occured in case of failure, valuated with CATERRNO
Returns:
S_OK If no problem has occured during the processing E_FAIL If any problem has occured. In this cas the method must set oError with CATERRNO
o OnOpen
public virtual HRESULT OnOpen( const CATUnicodeString* iFileName,
CATAccessRight iMode,
HRESULT* oGranted,
CATFileSystemError* oError)=0
Allows the user to perform some operations on the file to open.
Role: This method allows the user to perform same operations on the file that will be opened, such as changing its rights and controling the access right of the current user.
Parameters:
iFileName
The filename to open.
iMode
The requested mode for the opening.
oGranted
Says if the opening is possible
Legal values:
S_OK
It is allowed to open the file.
S_FALSE
It's not allowed to open the file.
oError
The system error that has occured in case of failure, valuated with CATERRNO
Returns:
S_OK If no problem has occured during the processing E_FAIL If any problem has occured. In this cas the method must set oError with CATERRNO

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

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