All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVIMultiSiteObjectMng

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface ENOVIMultiSiteObjectMng

Interface to access services for getting the replication information on an object.

Role:Class to be used by a client who wants replication information on an object.


Method Index


o GetSiteOwner(CATDbBinary&)
Get the ID of Site owning the object.
o GetSiteOwner(CATUnicodeString&)
Get the name of Site owning the object.
o IsOwnedByLocalSite()
Checks to see if the object is owned by the local site
o IsOwnedByTargetSite(CATDbBinary&)
Checks to see if the object is owned by the site identified by SiteId

Methods


o GetSiteOwner
public virtual HRESULT GetSiteOwner(CATDbBinary& oSiteId)=0
Get the ID of Site owning the object.
Parameters:
oSiteID
[out] a CATDbBinary.
Returns:
An HRESULT value.
Legal values:
S_OK
the site owner has been successfully retrieved
E_FAIL
An error occured during the process
o GetSiteOwner
public virtual HRESULT GetSiteOwner(CATUnicodeString& oSiteOwner)=0
Get the name of Site owning the object.
Parameters:
oSiteOwner
[out] A CATUnicodeString.
Returns:
An HRESULT value.
Legal values:
S_OK
the site owner has been successfully retrieved
E_FAIL
An error occured during the process
o IsOwnedByLocalSite
public virtual HRESULT IsOwnedByLocalSite()=0
Checks to see if the object is owned by the local site
Returns:
An HRESULT value.
Legal values:
S_OK
The object is owned by local site
E_FAIL
The object is owned by a remote site
o IsOwnedByTargetSite
public virtual HRESULT IsOwnedByTargetSite( const CATDbBinary& iSiteId) =0
Checks to see if the object is owned by the site identified by SiteId
Parameters:
iSiteId
[in].
Returns:
An HRESULT value.
Legal values:
S_OK
The object is owned by iSiteId
E_FAIL
The object is not owned by iSiteId

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

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