All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface VPMIAdmin

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

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


interface VPMIAdmin

This class supplies methods to manage administration data role: This class enables to create/delete/modify administration data


Method Index


o Abort()
Cancel of all the modifications which have been done since the last Save.
o AddBusinessDomain(VPMIBusinessDomain*)
Aggregate a businessdomain.
o AddDataDomain(VPMIDataDomain*)
Aggregate a datadomain.
o AddDomain(VPMIDomain*)
Aggregate a domain.
o AddExternSite(VPMIExternSite*)
Aggregate an externsite.
o AddHost(VPMIHost*)
Aggregate a host.
o AddProject(VPMIProject*)
Aggregate a project.
o AddReplPackageDefinition(VPMIReplPackageDefinition*)
Aggregate a replication package definition.
o AddReplSubscribingTarget(VPMIReplSubscribingTarget*)
Aggregate a replication target.
o AddReplSubscription(VPMIReplSubscription*)
Aggregate a Subscription.
o AddServer(VPMIServer*)
Aggregate a server.
o BeginModifications()
Enable modifications.
o CreateBusinessDomain(CATDbBinary&,VPMIBusinessDomain*&)
Create the business domain identified by iOid.
o CreateDataRDB(CATDbBinary&,VPMIDataRDB*&)
Create the dataRDB identified by iOid.
o CreateDataServer(CATDbBinary&,VPMIDataServer*&)
Create the dataserver identified by iOid.
o CreateDomain(CATDbBinary&,VPMIDomain*&)
Create the domain identified by iOid.
o CreateExternSite(CATDbBinary&,CATUnicodeString&,VPMIExternSite*&)
Create a new known site.
o CreateExternSite(CATDbBinary&,VPMIExternSite*&)
Create the site identified by iOid.
o CreateHost(CATDbBinary&,VPMIHost*&)
Create the host identified by iOid.
o CreateLocalSite(CATDbBinary&,VPMILocalSite*&)
Create the local installation definition.
o CreateObject(CATDbBinary&,VPMIAdmin::ADMINTYPE,IUnknown*&)
Method for parsing purpose: create object.
o CreateProject(CATDbBinary&,VPMIProject*&)
Create the project identified by iOid.
o CreateReplApplyStatus(CATDbBinary&,VPMIReplApplyStatus*&)
Create applystatus identified by iOid.
o CreateReplCaptureStatus(CATDbBinary&,VPMIReplCaptureStatus*&)
Create capturestatus identified by iOid.
o CreateReplMedia(CATDbBinary&,VPMIReplMedia*&)
Create a new definition to store the media for replication.
o CreateReplPackageDefinition(CATDbBinary&,CATUnicodeString&,VPMIReplPackageDefinition*&)
Create a new replication package.
o CreateReplPackageDefinition(CATDbBinary&,VPMIReplPackageDefinition*&)
Create the replication package identified by iOid.
o CreateReplSubscribingTarget(CATDbBinary&,CATUnicodeString&,VPMIReplPackageDefinition*,VPMIExternSite*,VPMIReplSubscribingTarget*&)
Create a new definition to replicate data for a site.
o CreateReplSubscribingTarget(CATDbBinary&,VPMIReplSubscribingTarget*&)
Create the replication target identified by iOid.
o CreateReplSubscription(CATDbBinary&,CATUnicodeString&,VPMIReplPackageDefinition*,VPMIExternSite*,VPMIReplSubscription*&)
Create a replication subscription.
o CreateReplSubscription(CATDbBinary&,VPMIReplSubscription*&)
Create the replication Subscription identified by iOid.
o CreateServer(CATDbBinary&,VPMIServer*&)
Create the server identified by iOid.
o End()
Release of the allocated resources.
o GenerateSubscription(VPMIReplSubscribingTarget*,CATUnicodeString&)
Generate a subscription string for a given target.
o GetAllExternSite(CATLISTP(IUnknown)&)
Get the list of all external site objects.
o GetAllReplPackageDefinition(CATLISTP(IUnknown)&)
Get the list of all package definition objects.
o GetAllReplSubscribingTarget(CATLISTP(IUnknown)&)
Get all subscribing targets known by the site.
o GetAllReplSubscription(CATLISTP(IUnknown)&)
Get the list of all Subscription objects.
o GetAppServer(CATUnicodeString&,VPMIAppServer**)
Get an application server object named iName.
o GetBusinessDomain(CATDbBinary&,VPMIBusinessDomain*&)
Get the business domain identified by iOid.
o GetBusinessDomain(CATUnicodeString&,VPMIBusinessDomain**)
Get a business domain object named iName.
o GetDataDomain(CATDbBinary&,VPMIDataDomain*&)
Get the dataRDB identified by iOid.
o GetDataDomain(CATDbBinary*,VPMIDataDomain**)
Get a DataDomain object from its OID.
o GetDataDomain(CATUnicodeString&,VPMIDataDomain**)
Get a data domain object named iName.
o GetDataServer(CATDbBinary&,VPMIDataServer*&)
Get the dataserver identified by iOid.
o GetDataServer(CATUnicodeString&,VPMIDataServer**)
Get a data server object named iName.
o GetDomain(CATDbBinary&,VPMIDomain*&)
Get the domain identified by iOid.
o GetDomain(CATUnicodeString&,VPMIDomain**)
Get a domain object named iDomainName.
o GetExternSite(CATDbBinary&,VPMIExternSite*&)
Get the site identified by iOid.
o GetExternSite(CATUnicodeString&,VPMIExternSite*&)
Get the extern site named iName.
o GetHost(CATDbBinary&,VPMIHost*&)
Get the host identified by iOid.
o GetHost(CATUnicodeString&,VPMIHost**)
get a host object from its name.
o GetListOfAppServers(CATLISTP(IUnknown)*)
Get the list of all application server objects.
o GetListOfBusinessDomains(CATLISTP(IUnknown)*)
Get the list of all business domain objects.
o GetListOfDataDomains(CATLISTP(IUnknown)*)
Get the list of all data domain objects.
o GetListOfDataServers(CATLISTP(IUnknown)*)
Get the list of all data server objects.
o GetListOfDomains(CATLISTP(IUnknown)*)
Get the list of all domain objects.
o GetListOfHosts(CATLISTP(IUnknown)*)
Get the list of all host objects.
o GetListOfProjects(CATLISTP(IUnknown)*)
Get the list of all project objects.
o GetListOfProjects(CATUnicodeString&,CATLISTP(IUnknown)*)
Get the list of all projects.
o GetListOfRelatedBusinessDomains(CATUnicodeString&,CATLISTP(IUnknown)*)
Get the list of all business domains objects related to a given schema.
o GetListOfVaultServers(CATLISTP(IUnknown)*)
Get the list of all vault server objects.
o GetLocalSite(VPMILocalSite*&)
Get the local site definition.
o GetMasterBusinessDomain(CATUnicodeString&,VPMIBusinessDomain**)
Get the master business domain object for a given schema.
o GetObject(CATDbBinary&,VPMIAdmin::ADMINTYPE,IUnknown*&)
Method for parsing purpose: get object.
o GetProject(CATDbBinary&,VPMIProject*&)
Get the project identified by iOid.
o GetProject(CATUnicodeString&,VPMIProject**)
Get a project object named iName.
o GetReplApplyStatus(CATDbBinary&,VPMIReplApplyStatus*&)
Get the apply status identified by iOid.
o GetReplCaptureStatus(CATDbBinary&,VPMIReplCaptureStatus*&)
Get the capture status identified by iOid.
o GetReplMedia(CATDbBinary&,VPMIReplMedia*&)
Get the media identified by iOid.
o GetReplPackageDefinition(CATDbBinary&,VPMIReplPackageDefinition*&)
Get the package definition identified by iOid.
o GetReplSubscribingTarget(CATDbBinary&,VPMIReplSubscribingTarget*&)
Get the subscribing target named iName.
o GetReplSubscribingTarget(CATUnicodeString&,VPMIReplSubscribingTarget*&)
Get the subscribing target named iName.
o GetReplSubscription(CATDbBinary&,VPMIReplSubscription*&)
Get the subscription from its iOid.
o GetServer(CATDbBinary&,VPMIServer*)
Get the server identified by iOid.
o GetVaultServer(CATUnicodeString&,VPMIVaultServer**)
Get a vault server object named iName.
o Init(CATUnicodeString&,CATUnicodeString&,int)
Initialization.
o RemoveAllInstances()
mark all instances aggregated by the VPMIAdmin to be deleted.
o Save()
Save of all the modifications which have been done during the current logical unit of work.
o SetLocalSite(VPMILocalSite*)
set the local site of the current installation.
o Subscribe(CATUnicodeString&,VPMIReplSubscription*&)
Update the Admin with a new subscription.

Enumerated Type Index


o ADMINTYPE
Enum of admin types.

Methods


o Abort
public virtual HRESULT Abort()=0
Cancel of all the modifications which have been done since the last Save.
Returns:
an HRESULT value.
Legal values: S_OK: E_FAIL:
o AddBusinessDomain
public virtual HRESULT AddBusinessDomain( const VPMIBusinessDomain* pBusinessDomain)=0
Aggregate a businessdomain.
Parameters:
iBusinessDomain
the BusinessDomain to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddDataDomain
public virtual HRESULT AddDataDomain( const VPMIDataDomain* iDataDomain)=0
Aggregate a datadomain.
Parameters:
iDataDomain
the DataDomain to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddDomain
public virtual HRESULT AddDomain( const VPMIDomain* pDomain)=0
Aggregate a domain.
Parameters:
iBusinessDomain
the BusinessDomain to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddExternSite
public virtual HRESULT AddExternSite( const VPMIExternSite* iExternSite)=0
Aggregate an externsite.
Parameters:
iExternSite
the Site to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddHost
public virtual HRESULT AddHost( const VPMIHost* pHost)=0
Aggregate a host.
Parameters:
iBusinessDomain
the BusinessDomain to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddProject
public virtual HRESULT AddProject( const VPMIProject* iProject)=0
Aggregate a project.
Parameters:
iProject
the Project to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddReplPackageDefinition
public virtual HRESULT AddReplPackageDefinition( const VPMIReplPackageDefinition* iPackageDefinition)=0
Aggregate a replication package definition.
Parameters:
iPackage
the replication package to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddReplSubscribingTarget
public virtual HRESULT AddReplSubscribingTarget( const VPMIReplSubscribingTarget* iTarget)=0
Aggregate a replication target.
Parameters:
iTarget
the replication target to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddReplSubscription
public virtual HRESULT AddReplSubscription( const VPMIReplSubscription* iSubscription)=0
Aggregate a Subscription.
Parameters:
iSubscription
the replication Subscription to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o AddServer
public virtual HRESULT AddServer( const VPMIServer* iServer)=0
Aggregate a server.
Parameters:
iServer
the server to aggregate
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o BeginModifications
public virtual HRESULT BeginModifications()=0
Enable modifications. =>Do not use it during the VPMSession.
Returns:
an HRESULT value.
Legal values: S_OK: E_FAIL:
o CreateBusinessDomain
public virtual HRESULT CreateBusinessDomain( const CATDbBinary& iOid,
VPMIBusinessDomain*& oBusinessDomain)=0
Create the business domain identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oBusinessDomain
the business domain to create
Returns:
an HRESULT value.
Legal values: S_OK: business domain created S_FALSE:business domain not created E_FAIL:system error
o CreateDataRDB
public virtual HRESULT CreateDataRDB( const CATDbBinary& iOid,
VPMIDataRDB*& oRDB)=0
Create the dataRDB identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDataServer
the dataserver to create
Returns:
an HRESULT value.
Legal values: S_OK: domain created S_FALSE:domain not created E_FAIL:system error
o CreateDataServer
public virtual HRESULT CreateDataServer( const CATDbBinary& iOid,
VPMIDataServer*& oDataServer)=0
Create the dataserver identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDataServer
the dataserver to create
Returns:
an HRESULT value.
Legal values: S_OK: domain created S_FALSE:domain not created E_FAIL:system error
o CreateDomain
public virtual HRESULT CreateDomain( const CATDbBinary& iOid,
VPMIDomain*& oDomain)=0
Create the domain identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDomain
the domain to create
Returns:
an HRESULT value.
Legal values: S_OK: domain created S_FALSE:domain not created E_FAIL:system error
o CreateExternSite
public virtual HRESULT CreateExternSite( const CATDbBinary& iOid,
const CATUnicodeString& iName,
VPMIExternSite*& oSite)=0
Create a new known site.
Parameters:
iOid

Legal values: a 16-bytes identifier.
iName
this string is not an identifier.
but is required to be unique for all site definition.
oSite
a new site
Returns:
an HRESULT value.
Legal values: S_OK:site created S_FALSE:the identifier iOid already exists. E_FAIL:
o CreateExternSite
public virtual HRESULT CreateExternSite( const CATDbBinary& iOid,
VPMIExternSite*& oDomain)=0
Create the site identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDomain
the domain to create
Returns:
an HRESULT value.
Legal values: S_OK: site created S_FALSE:site not created E_FAIL:system error
o CreateHost
public virtual HRESULT CreateHost( const CATDbBinary& iOid,
VPMIHost*& oHost)=0
Create the host identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oHost
the host to create
Returns:
an HRESULT value.
Legal values: S_OK: domain created S_FALSE:domain not created E_FAIL:system error
o CreateLocalSite
public virtual HRESULT CreateLocalSite( const CATDbBinary& iBin,
VPMILocalSite*& oSite)=0
Create the local installation definition.
Parameters:
iBin
the identifier of the localSite. but is required to be unique for all site definition.
oSite
a new site
Returns:
an HRESULT value.
Legal values: S_OK:site created S_FALSE:the site already exists E_FAIL:
o CreateObject
public virtual HRESULT CreateObject( const CATDbBinary& iOid,
const VPMIAdmin::ADMINTYPE iType,
IUnknown*& oObject)=0
Method for parsing purpose: create object.
o CreateProject
public virtual HRESULT CreateProject( const CATDbBinary& iOid,
VPMIProject*& oProject)=0
Create the project identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oProject
the project to create
Returns:
an HRESULT value.
Legal values: S_OK: project not created S_FALSE:project not created E_FAIL:system error
o CreateReplApplyStatus
public virtual HRESULT CreateReplApplyStatus( const CATDbBinary& iOid,
VPMIReplApplyStatus*& oStatus)=0
Create applystatus identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oProject
the project to create
Returns:
an HRESULT value.
Legal values: S_OK: project not created S_FALSE:project not created E_FAIL:system error
o CreateReplCaptureStatus
public virtual HRESULT CreateReplCaptureStatus( const CATDbBinary& iOid,
VPMIReplCaptureStatus*& oStatus)=0
Create capturestatus identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oProject
the project to create
Returns:
an HRESULT value.
Legal values: S_OK: status not created S_FALSE:status not created E_FAIL:system error
o CreateReplMedia
public virtual HRESULT CreateReplMedia( const CATDbBinary& iOid,
VPMIReplMedia*& oMedia) =0
Create a new definition to store the media for replication.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oMedia
the media object created.
Returns:
an HRESULT value.
Legal values: S_OK:media created S_FALSE:the identifier iOid already exists. E_FAIL:
o CreateReplPackageDefinition
public virtual HRESULT CreateReplPackageDefinition( const CATDbBinary& iOid,
const CATUnicodeString& iName,
VPMIReplPackageDefinition*& oPackage)=0
Create a new replication package.
Parameters:
iOid

Legal values: a 16-bytes identifier.
iName
this string is not an identifier.
but is required to be unique for all package definition
oPackage
a new package
Returns:
an HRESULT value.
Legal values: S_OK:package created S_FALSE:the identifier iOid already exists. E_FAIL:
o CreateReplPackageDefinition
public virtual HRESULT CreateReplPackageDefinition( const CATDbBinary& iOid,
VPMIReplPackageDefinition*& oReplPackage)=0
Create the replication package identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oReplPackage
the replication package to create
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:system error
o CreateReplSubscribingTarget
public virtual HRESULT CreateReplSubscribingTarget( const CATDbBinary& iOid,
const CATUnicodeString& iName,
const VPMIReplPackageDefinition* iPackage,
const VPMIExternSite* iSite,
VPMIReplSubscribingTarget*& oTarget)=0
Create a new definition to replicate data for a site.
Parameters:
iOid

Legal values: a 16-bytes identifier.
iName
this string is not an identifier.
but is required to be unique for all target definition.
iPackage
the package to send.
iSite
the site where data will be send.
oTarget
the subscribing target created.
Returns:
an HRESULT value.
Legal values: S_OK:target created S_FALSE:the identifier iOid already exists. E_FAIL:
o CreateReplSubscribingTarget
public virtual HRESULT CreateReplSubscribingTarget( const CATDbBinary& iOid,
VPMIReplSubscribingTarget*& oReplTarget)=0
Create the replication target identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oReplTarget
the replication target to create
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:system error
o CreateReplSubscription
public virtual HRESULT CreateReplSubscription( const CATDbBinary& iOid,
const CATUnicodeString& iName,
const VPMIReplPackageDefinition* iPackage,
const VPMIExternSite* iSite,
VPMIReplSubscription*& oSubscription)=0
Create a replication subscription.
Parameters:
iOid

Legal values: a 16-bytes identifier.
iName
this string is not an identifier.
but is required to be unique for all subscription.
iPackage
the package defining the data received
iSite
the site from which the data are coming.
oSubscription
the replication subscription created.
Returns:
an HRESULT value.
Legal values: S_OK:subscription created S_FALSE:the identifier iOid already exists. E_FAIL:
o CreateReplSubscription
public virtual HRESULT CreateReplSubscription( const CATDbBinary& iOid,
VPMIReplSubscription*& oReplSubscription)=0
Create the replication Subscription identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oReplSubscription
the replication Subscription to create
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:system error
o CreateServer
public virtual HRESULT CreateServer( const CATDbBinary& iOid,
VPMIServer*& oServer)=0
Create the server identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oServer
the server to create
Returns:
an HRESULT value.
Legal values: S_OK: server not created S_FALSE: server not created E_FAIL:system error
o End
public virtual HRESULT End()=0
Release of the allocated resources.
Returns:
an HRESULT value.
Legal values: S_OK: E_FAIL:
o GenerateSubscription
public virtual HRESULT GenerateSubscription( const VPMIReplSubscribingTarget* iTarget,
CATUnicodeString& oBuf)=0
Generate a subscription string for a given target.
Parameters:
iTarget
the target where the string will be send.
oBuf
the string containing the subscription
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE:subscription refused E_FAIL:
o GetAllExternSite
public virtual HRESULT GetAllExternSite(CATLISTP(IUnknown)& lExternSite)const=0
Get the list of all external site objects.
o GetAllReplPackageDefinition
public virtual HRESULT GetAllReplPackageDefinition(CATLISTP(IUnknown)& olReplPackageDefinition) const =0
Get the list of all package definition objects.
o GetAllReplSubscribingTarget
public virtual HRESULT GetAllReplSubscribingTarget(CATLISTP(IUnknown)& oSubscribingTargets)=0
Get all subscribing targets known by the site.
Parameters:
oSubscribingTargets
the list required
Returns:
an HRESULT value.
Legal values: S_OK:site found S_FALSE:site not found E_FAIL:
o GetAllReplSubscription
public virtual HRESULT GetAllReplSubscription(CATLISTP(IUnknown)& oSubscription) =0
Get the list of all Subscription objects.
o GetAppServer
public virtual HRESULT GetAppServer( const CATUnicodeString& iName,
VPMIAppServer** oServer)=0
Get an application server object named iName.
o GetBusinessDomain
public virtual HRESULT GetBusinessDomain( const CATDbBinary& iOid,
VPMIBusinessDomain*& oBusinessDomain)=0
Get the business domain identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oBusinessDomain
the business domain required
Returns:
an HRESULT value.
Legal values: S_OK: business domain found S_FALSE:business domain not found E_FAIL:system error
o GetBusinessDomain
public virtual HRESULT GetBusinessDomain( const CATUnicodeString& iName,
VPMIBusinessDomain** oBusinessDomain)=0
Get a business domain object named iName.
o GetDataDomain
public virtual HRESULT GetDataDomain( const CATDbBinary& iOid,
VPMIDataDomain*& oDataRDB)=0
Get the dataRDB identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDataServer
the dataserver required
Returns:
an HRESULT value.
Legal values: S_OK: domain found S_FALSE:domain not found E_FAIL:system error
o GetDataDomain
public virtual HRESULT GetDataDomain(CATDbBinary* iOID,
VPMIDataDomain** oDataDomain)=0
Get a DataDomain object from its OID.
o GetDataDomain
public virtual HRESULT GetDataDomain( const CATUnicodeString& iName,
VPMIDataDomain** oDataRDB)=0
Get a data domain object named iName.
o GetDataServer
public virtual HRESULT GetDataServer( const CATDbBinary& iOid,
VPMIDataServer*& oDataServer)=0
Get the dataserver identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDataServer
the dataserver required
Returns:
an HRESULT value.
Legal values: S_OK: domain found S_FALSE:domain not found E_FAIL:system error
o GetDataServer
public virtual HRESULT GetDataServer( const CATUnicodeString& iName,
VPMIDataServer** oServer)=0
Get a data server object named iName.
o GetDomain
public virtual HRESULT GetDomain( const CATDbBinary& iOid,
VPMIDomain*& oDomain)=0
Get the domain identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDomain
the domain required
Returns:
an HRESULT value.
Legal values: S_OK: domain found S_FALSE:domain not found E_FAIL:system error
o GetDomain
public virtual HRESULT GetDomain( const CATUnicodeString& iDomainName,
VPMIDomain** oDomain)=0
Get a domain object named iDomainName.
o GetExternSite
public virtual HRESULT GetExternSite( const CATDbBinary& iOid,
VPMIExternSite*& oDomain)=0
Get the site identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oDomain
the domain required
Returns:
an HRESULT value.
Legal values: S_OK: site found S_FALSE:site not found E_FAIL:system error
o GetExternSite
public virtual HRESULT GetExternSite( const CATUnicodeString& iName,
VPMIExternSite*& oSite)=0
Get the extern site named iName.
Parameters:
iName
the name of the site looked for.
oSite
the looked for site.
Returns:
an HRESULT value.
Legal values: S_OK:site found S_FALSE:site not found E_FAIL:
o GetHost
public virtual HRESULT GetHost( const CATDbBinary& iOid,
VPMIHost*& oHost)=0
Get the host identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oHost
the host required
Returns:
an HRESULT value.
Legal values: S_OK: domain found S_FALSE:domain not found E_FAIL:system error
o GetHost
public virtual HRESULT GetHost( const CATUnicodeString& iName,
VPMIHost** oHost)=0
get a host object from its name.
o GetListOfAppServers
public virtual HRESULT GetListOfAppServers(CATLISTP(IUnknown)* oListOfAppServers)=0
Get the list of all application server objects.
o GetListOfBusinessDomains
public virtual HRESULT GetListOfBusinessDomains(CATLISTP(IUnknown)* oListOfBusinessDomains)=0
Get the list of all business domain objects.
o GetListOfDataDomains
public virtual HRESULT GetListOfDataDomains(CATLISTP(IUnknown)* oListOfDataDomains)=0
Get the list of all data domain objects.
o GetListOfDataServers
public virtual HRESULT GetListOfDataServers(CATLISTP(IUnknown)* oListOfDataServers)=0
Get the list of all data server objects.
o GetListOfDomains
public virtual HRESULT GetListOfDomains(CATLISTP(IUnknown)* oListOfDomains)=0
Get the list of all domain objects.
Returns:
an HRESULT value.
Legal values: S_OK: E_FAIL:
o GetListOfHosts
public virtual HRESULT GetListOfHosts(CATLISTP(IUnknown)* oListOfHosts)=0
Get the list of all host objects.
o GetListOfProjects
public virtual HRESULT GetListOfProjects(CATLISTP(IUnknown)* oListOfProjects)=0
Get the list of all project objects.
Returns:
an HRESULT value.
Legal values: S_OK: E_FAIL:
o GetListOfProjects
public virtual HRESULT GetListOfProjects( const CATUnicodeString& iUserName,
CATLISTP(IUnknown)* oListOfProjects)=0
Get the list of all projects. N.B.: input user name parameter is not used.
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o GetListOfRelatedBusinessDomains
public virtual HRESULT GetListOfRelatedBusinessDomains( const CATUnicodeString& iSchemaName,
CATLISTP(IUnknown)* oList)=0
Get the list of all business domains objects related to a given schema.
o GetListOfVaultServers
public virtual HRESULT GetListOfVaultServers(CATLISTP(IUnknown)* oListOfVaultServers)=0
Get the list of all vault server objects.
o GetLocalSite
public virtual HRESULT GetLocalSite(VPMILocalSite*& oSite)=0
Get the local site definition.
Parameters:
oSite
the looked for site.
Returns:
an HRESULT value.
Legal values: S_OK:site found S_FALSE:site not found E_FAIL:
o GetMasterBusinessDomain
public virtual HRESULT GetMasterBusinessDomain( const CATUnicodeString& iSchemaName,
VPMIBusinessDomain** oBusinessDomain)=0
Get the master business domain object for a given schema.
o GetObject
public virtual HRESULT GetObject( const CATDbBinary& iOid,
const VPMIAdmin::ADMINTYPE iType,
IUnknown*& oObject)=0
Method for parsing purpose: get object.
o GetProject
public virtual HRESULT GetProject( const CATDbBinary& iOid,
VPMIProject*& oProject)=0
Get the project identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oProject
the project required
Returns:
an HRESULT value.
Legal values: S_OK: project not found S_FALSE:project not found E_FAIL:system error
o GetProject
public virtual HRESULT GetProject( const CATUnicodeString& iName,
VPMIProject** oProject)=0
Get a project object named iName.
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o GetReplApplyStatus
public virtual HRESULT GetReplApplyStatus( const CATDbBinary& iOid,
VPMIReplApplyStatus*& oStatus)=0
Get the apply status identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oStatus
the status looked for.
Returns:
an HRESULT value.
Legal values: S_OK:status found S_FALSE:status not found E_FAIL:
o GetReplCaptureStatus
public virtual HRESULT GetReplCaptureStatus( const CATDbBinary& iOid,
VPMIReplCaptureStatus*& oStatus)=0
Get the capture status identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oStatus
the status looked for.
Returns:
an HRESULT value.
Legal values: S_OK:status found S_FALSE:status not found E_FAIL:
o GetReplMedia
public virtual HRESULT GetReplMedia( const CATDbBinary& iOid,
VPMIReplMedia*& oMedia)=0
Get the media identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oMedia
the media looked for.
Returns:
an HRESULT value.
Legal values: S_OK:media found S_FALSE:media not found E_FAIL:
o GetReplPackageDefinition
public virtual HRESULT GetReplPackageDefinition( const CATDbBinary& iOid,
VPMIReplPackageDefinition*& oPackage)=0
Get the package definition identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oPackage
the package looked for.
Returns:
an HRESULT value.
Legal values: S_OK:package found S_FALSE:package not found E_FAIL:
o GetReplSubscribingTarget
public virtual HRESULT GetReplSubscribingTarget( const CATDbBinary& iOid,
VPMIReplSubscribingTarget*& oTarget)=0
Get the subscribing target named iName.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oSite
the site looked for.
Returns:
an HRESULT value.
Legal values: S_OK:site found S_FALSE:site not found E_FAIL:
o GetReplSubscribingTarget
public virtual HRESULT GetReplSubscribingTarget( const CATUnicodeString& iName,
VPMIReplSubscribingTarget*& oTarget)=0
Get the subscribing target named iName.
Parameters:
iName
the name of the target looked for.
oSite
the site looked for.
Returns:
an HRESULT value.
Legal values: S_OK:site found S_FALSE:site not found E_FAIL:
o GetReplSubscription
public virtual HRESULT GetReplSubscription( const CATDbBinary& iOid,
VPMIReplSubscription*& oSubscription)=0
Get the subscription from its iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oSite
the site looked for.
Returns:
an HRESULT value.
Legal values: S_OK:site found S_FALSE:site not found E_FAIL:
o GetServer
public virtual HRESULT GetServer( const CATDbBinary& iOid,
VPMIServer* oServer)=0
Get the server identified by iOid.
Parameters:
iOid

Legal values: a 16-bytes identifier.
oProject
the project required
Returns:
an HRESULT value.
Legal values: S_OK: server not found S_FALSE: server not found E_FAIL:system error
o GetVaultServer
public virtual HRESULT GetVaultServer( const CATUnicodeString& iName,
VPMIVaultServer** oServer)=0
Get a vault server object named iName.
o Init
public virtual HRESULT Init( const CATUnicodeString& iUserName="",
const CATUnicodeString& iPassword="",
const int iLoadAdmin= 0 )=0
Initialization. Default Authentication is System N.B.: iLoadAdmin > 0 in the LoadAdmin load only.
Returns:
an HRESULT value.
Legal values: S_OK: E_FAIL:
o RemoveAllInstances
public virtual HRESULT RemoveAllInstances()=0
mark all instances aggregated by the VPMIAdmin to be deleted.
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o Save
public virtual HRESULT Save()=0
Save of all the modifications which have been done during the current logical unit of work.
Returns:
an HRESULT value.
Legal values: S_OK: E_FAIL:
o SetLocalSite
public virtual HRESULT SetLocalSite( const VPMILocalSite* iSite)=0
set the local site of the current installation.
Parameters:
iSite
the local site.
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE: E_FAIL:
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iBuf,
VPMIReplSubscription*& oSubscription)=0
Update the Admin with a new subscription.
Parameters:
iBuf
the string containing the subscription definition
oSubscription
Returns:
an HRESULT value.
Legal values: S_OK: S_FALSE:subscription refused E_FAIL:

Enumerated Types


o ADMINTYPE
enum ADMINTYPE {
  ADMINAPPLYSTATUS,
  ADMINAPPSERVER,
  ADMINCAPTURESTATUS,
  ADMINBUSINESSDOMAIN,
  ADMINDATAFILE,
  ADMINDATARDB,
  ADMINDATASERVER,
  ADMINDOMAIN,
  ADMINEXTERNSITE,
  ADMINHOST,
  ADMINLOCALSITE,
  ADMINMEDIA,
  ADMINPACKAGEDEFINITION,
  ADMINPROJECT,
  ADMINSERVER,
  ADMINSUBSCRIBINGTARGET,
  ADMINSUBSCRIPTION,
  ADMINVAULTSERVER
}
Enum of admin types.

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

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