All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATICfgXEff
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICfgXEff
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICfgXEff
Interface to associate a Domain to an Effectivity expression.
Role:
The XEffectivity is a convenient way to associate one Domain to one Effectivity expression.
The Domain is set at the XEffectivity creation, using the CATICfgManager.CreateXEff factory method.
Method Index
- o
GetDomainName(CATUnicodeString&)
- Returns the Domain to which the Effectivity expression is associated.
- o
GetEffectivity(CATICfgEffectivity_var&)
- Returns the Effectivity expression.
- o
GetListOfBasicEff(CATListValCATICfgBasicEffectivity_var&)
- Returns the Effectivity expression as a list of Basic Effectivities.
- o
SetEffectivity(CATICfgEffectivity_var&,int)
- Sets a new Effectivity expression.
Methods
o GetDomainName
-
Returns the Domain to which the Effectivity expression is associated.
- Parameters:
-
- oName
- The name of the Domain for this XEffectivity.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Domain name is successfully retrieved
- E_FAIL
- An error occured during the Domain name extraction
o GetEffectivity
public virtual HRESULT GetEffectivity( | CATICfgEffectivity_var& | oEffectivity)const = 0 |
-
Returns the Effectivity expression.
- Parameters:
-
- oEffectivity
- The Effectivity expression
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Effectivity expression is successfully extracted
- E_FAIL
- An error occured during the Effectivity expression extraction
o GetListOfBasicEff
public virtual HRESULT GetListOfBasicEff( | CATListValCATICfgBasicEffectivity_var& | oListBasicEff)const = 0 |
-
Returns the Effectivity expression as a list of Basic Effectivities.
- Parameters:
-
- oList
- The list of Basic Effectivities forming the Effectivity expression
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Effectivity expression is successfully extracted and converted
- E_FAIL
- An error occured during the Effectivity expression extraction and/or conversion
o SetEffectivity
public virtual HRESULT SetEffectivity( | const CATICfgEffectivity_var& | iEffectivity, |
| const int | iPersistent | = 1 )= 0 |
-
Sets a new Effectivity expression.
- Parameters:
-
- iEffectivity
- The new Effectivity expression to set.
- iPersistent
- A flag to make the new Effectivity expression persistent or not.
Legal values:
- 1
- The Effectivity expression is made persistent. This is the default value.
- 0
- The Effectivity expression is left volatile.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Effectivity expression is successfully changed
- E_FAIL
- An error occured during the Effectivity expression change
This object is included in the file: CATICfgXEff.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces