All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

CDMAInteroperability Interface CATIVPMAccess

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

Usage: you can freely reimplement this interface.


interface CATIVPMAccess

CATIVPMAccess allows to retrieve data from a ENOVIAvpm V4 database.
Role: This interface is called on typed object that corresponds to the opening method of a long field in ENOVIAvpm V4.
So, for instance, if the $CUR_ACC_MET_DATA column of the $EXT_LF table gives DBLFAIX, then the implementation of the 'DBLFAIX' object will be called to read the file.

Note: Only the following access methods are supported:


Method Index


o ExtractLFToFile(int&,char*,CATUnicodeString&)
Extracts a long field from the ENOVIAvpm V4 database to a file.
o ExtractLFToMemory(int&,char*,int&,char*&)
Extracts a long field from the ENOVIAvpm V4 database and opens it in memory .
o ReadDone(CATUnicodeString&)
Post-treatment once the document associated to the long field has been read.

Methods


o ExtractLFToFile
public virtual HRESULT ExtractLFToFile(int& ilgLF,
char* iLongField,
CATUnicodeString& ioPath) = 0
Extracts a long field from the ENOVIAvpm V4 database to a file.
Role: This method extracts the given long field from the ENOVIAvpm V4 database and saves it a local file.
Use CATIVPMAccess.ReadDone when the local file is no longer necessary.
Parameters:
ilgLF
length of the long field
iLongField
The path to the long field (the $CUR_ACC_MET_DATA column of $EXT_LF table)
ioPath
The path to the file.
If ioPath is not NULL, the document is copied to the specified location.
Otherwise, it could be put on file anywhere.
Returns:
  • S_OK: execution successful
  • E_FAIL: The method has failed. A CATError class instance is generated.
o ExtractLFToMemory
public virtual HRESULT ExtractLFToMemory(int& ilgLF,
char* iLongField,
int& olgBuffer,
char*& oBuffer) = 0
Extracts a long field from the ENOVIAvpm V4 database and opens it in memory .
Role: This methods extracts the given long field from the ENOVIAvpm V4 database and opens it in a buffer in memory.

Parameters:
ilgLF
length of the long field
iLongField
The path to the long field (the $CUR_ACC_MET_DATA column of $EXT_LF table)
olgBuffer
length of the opened buffer
oBuffer
The opened buffer.
Returns:
  • S_OK: execution successful
  • E_FAIL: The method has failed. A CATError class instance is generated.
o ReadDone
public virtual HRESULT ReadDone( const CATUnicodeString& iPath) = 0
Post-treatment once the document associated to the long field has been read.
Role: This method enables release the file containing the long field stored previously using ExtractLFToFile, once the contained document has been read and is no longer necessary.
Note:This method must be used only after CATIVPMAccess.ExtractLFToFile with the returned path.
Parameters:
iPath
path of the file
Returns:
  • S_OK: execution successful

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

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