All Frameworks Class Hierarchy This Framework Next Indexes
CATOBMInterfaces Interface CATIBKTBehaviorSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIBKTBehaviorSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIBKTBehaviorSettingAtt
Enables attribute access to BKT options.
Method Index
- o
GetBKTAccessRights(unsigned int&)
- Retrieves the BKTAccessRights attribute.
- o
GetBKTAccessRightsInfo(CATSettingInfo*)
- Retrieves the state of the BKTAccessRights parameter.
- o
GetBKTBehaviorOperationMessage(unsigned int&)
- Retrieves or sets the BKTBehaviorOperationMessage parameter.
- o
GetBKTBehaviorOperationMessageInfo(CATSettingInfo*)
- Retrieves the state of the BKTBehaviorOperationMessage parameter.
- o
GetBKTSpecificationTree(unsigned int&)
- Retrieves the BKTSpecificationTree parameter.
- o
GetBKTSpecificationTreeInfo(CATSettingInfo*)
- Retrieves the state of the BKTSpecificationTree parameter.
- o
SetBKTAccessRights(unsigned int)
- Sets the BKTAccessRights attribute.
- o
SetBKTAccessRightsLock(unsigned char)
- Locks or unlocks the BKTAccessRights parameter.
- o
SetBKTBehaviorOperationMessage(unsigned int)
- Sets the BKTBehaviorOperationMessage parameter.
- o
SetBKTBehaviorOperationMessageLock(unsigned char)
- Locks or unlocks the BKTBehaviorOperationMessage parameter.
- o
SetBKTSpecificationTree(unsigned int)
- Sets the BKTSpecificationTree parameter.
- o
SetBKTSpecificationTreeLock(unsigned char)
- Locks or unlocks the BKTSpecificationTree parameter.
Methods
o GetBKTAccessRights
public virtual HRESULT GetBKTAccessRights( | unsigned int& | ioBKTAccessRights)= 0 |
-
Retrieves the BKTAccessRights attribute.
- Parameters:
-
- ioBKTAccessRights
- Legal values:
0 : User mode
1: Administrator mode
2: Expert mode
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTAccessRightsInfo
-
Retrieves the state of the BKTAccessRights parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTBehaviorOperationMessage
public virtual HRESULT GetBKTBehaviorOperationMessage( | unsigned int& | ioBKTBehaviorOperationMessage)= 0 |
-
Retrieves or sets the BKTBehaviorOperationMessage parameter.
- Parameters:
-
- ioBKTBehaviorOperationMessage
- Legal values:
0 : No operation messages
1: with operation messages
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTBehaviorOperationMessageInfo
-
Retrieves the state of the BKTBehaviorOperationMessage parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTSpecificationTree
public virtual HRESULT GetBKTSpecificationTree( | unsigned int& | ioBKTSpecificationTree)= 0 |
-
Retrieves the BKTSpecificationTree parameter.
- Parameters:
-
- ioBKTSpecificationTree
- Legal values:
0 : hides behaviors variables
1: displays behaviors variables
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTSpecificationTreeInfo
-
Retrieves the state of the BKTSpecificationTree parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTAccessRights
public virtual HRESULT SetBKTAccessRights( | unsigned int | iBKTAccessRights) = 0 |
-
Sets the BKTAccessRights attribute.
- Parameters:
-
- iBKTAccessRights
- Legal values:
0 : User mode
1: Administrator mode
2: Expert mode
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTAccessRightsLock
public virtual HRESULT SetBKTAccessRightsLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the BKTAccessRights parameter.
Role: Locks or unlocks the BKTAccessRights parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTBehaviorOperationMessage
public virtual HRESULT SetBKTBehaviorOperationMessage( | unsigned int | iBKTBehaviorOperationMessage) = 0 |
-
Sets the BKTBehaviorOperationMessage parameter.
- Parameters:
-
- iBKTBehaviorOperationMessage
- Legal values:
0 : No operation messages
1: with operation messages
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTBehaviorOperationMessageLock
public virtual HRESULT SetBKTBehaviorOperationMessageLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the BKTBehaviorOperationMessage parameter.
Role: Locks or unlocks the BKTBehaviorOperationMessage parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTSpecificationTree
public virtual HRESULT SetBKTSpecificationTree( | unsigned int | iBKTSpecificationTree) = 0 |
-
Sets the BKTSpecificationTree parameter.
- Parameters:
-
- iBKTSpecificationTree
- Legal values:
0 : hides behaviors variables
1: displays behaviors variables
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTSpecificationTreeLock
public virtual HRESULT SetBKTSpecificationTreeLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the BKTSpecificationTree parameter.
Role: Locks or unlocks the BKTSpecificationTree parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: CATIBKTBehaviorSettingAtt.h
If needed, your Imakefile.mk should include the module: CATOBMItf