All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Class CATEASchAppMultiImage

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

Usage: you can derive this class.


public class CATEASchAppMultiImage

Super class to derive implementation for interface CATISchAppReplace.
Role: Adaptor


Constructor and Destructor Index


o CATEASchAppMultiImage()
Constructs an empty CATEASchAppReplace.
o ~CATEASchAppMultiImage()

Method Index


o AppGetMasterDocument(CATDocument*&,CATUnicodeString&,CATUnicodeString&)
Get the document where the master of this image object resides.
o AppGetMasterObject(CATISchAppMultiImageMaster**)
Get the master object of this image.
o AppIsUpToDate(CATSchMIOImageStatus&)
Check if the image object is up-to-date.
o AppUpdate(CATISchAppMultiImageMaster*,CATISchAppMultiImage**)
Update the image object.

Constructor and Destructor


o CATEASchAppMultiImage
public CATEASchAppMultiImage()
Constructs an empty CATEASchAppReplace.
o ~CATEASchAppMultiImage
public virtual ~CATEASchAppMultiImage()

Methods


o AppGetMasterDocument
public virtual HRESULT AppGetMasterDocument(CATDocument*& oDocument,
CATUnicodeString& oDocumentName,
CATUnicodeString& oSymbolicLinkName)
Get the document where the master of this image object resides.
Parameters:
oDocument
Pointer to the document. Do not release output pointer (no AddRef is done).
oDocumentName
Name of the document containing the master.
oSymbolicLinkName
Name of the symbolic link.
o AppGetMasterObject
public virtual HRESULT AppGetMasterObject(CATISchAppMultiImageMaster** oMasterImage)
Get the master object of this image.
Parameters:
oMasterImage
[out, IUnknown#Release] Pointer to the master object.
o AppIsUpToDate
public virtual HRESULT AppIsUpToDate(CATSchMIOImageStatus& oStatus)
Check if the image object is up-to-date.
Parameters:
oStatus
Possible Enum values: Enum values need to be mapped to those provided by PSP.
o AppUpdate
public virtual HRESULT AppUpdate( const CATISchAppMultiImageMaster* iMasterImage,
CATISchAppMultiImage** oImage)
Update the image object.
Parameters:
iMasterImage
This is an optional input. Not NULL - the application has a handle on the master to update this image (for example in DSA application, the application will make sure the ID of this image is the same as the input master). NULL - the application will find the master based on the specific way it models the MIO concept. Sample case: the application will make sure the ID of this image is the same as the input master.
oImage
Pointer to a new image object created if existing image object has to be replaced during the update process. This pointer is NULL if the image object is not replaced.

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

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