All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATIAApplicationFrame Interface CATICafDocumentationSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICafDocumentationSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICafDocumentationSettingAtt
Interface to the Documentation setting controller.
Role: The Documentation setting controller is dedicated to manage
the setting parameters displayed in the Help property page.
Method Index
- o
GetCompanionPath(CATUnicodeString&)
- Retrieves the User Companion Location setting attribute value.
- o
GetCompanionPathInfo(CATSettingInfo*)
- Retrieves the User Companion Location setting attribute information object.
- o
GetDocLanguage(int&)
- Retrieves the Technical Documentation Language setting attribute value.
- o
GetDocLanguageInfo(CATSettingInfo*)
- Retrieves the Technical Documentation Language setting attribute information object.
- o
GetPriority(CATDocContextualPriority&)
- Retrieves the Contextual Priority setting attribute value.
- o
GetPriorityInfo(CATSettingInfo*)
- Retrieves the Contextual Priority setting attribute information object.
- o
GetTechnicalDocumentationPath(CATUnicodeString&)
- Retrieves the Technical Documentation Location setting attribute value.
- o
GetTechnicalDocumentationPathInfo(CATSettingInfo*)
- Retrieves the Technical Documentation Location setting attribute information object.
- o
SetCompanionPath(CATUnicodeString&)
- Sets the User Companion Location setting attribute value.
- o
SetCompanionPathLock(unsigned char)
- Locks or unlocks the User Companion Location setting attribute.
- o
SetDocLanguage(int&)
- Sets the Technical Documentation Language setting attribute value.
- o
SetDocLanguageLock(unsigned char)
- Locks or unlocks the Technical Documentation Language setting attribute.
- o
SetPriority(CATDocContextualPriority&)
- Sets the Contextual Priority setting attribute value.
- o
SetPriorityLock(unsigned char)
- Locks or unlocks the Contextual Priority setting attribute.
- o
SetTechnicalDocumentationPath(CATUnicodeString&)
- Sets the Technical Documentation Location setting attribute value.
- o
SetTechnicalDocumentationPathLock(unsigned char)
- Locks or unlocks the Technical Documentation Location setting attribute.
Methods
o GetCompanionPath
-
Retrieves the User Companion Location setting attribute value.
Role: The User Companion Location setting attribute manages the location or path where the User Companion is installed
- Parameters:
-
- ioPath
- [inout] The User Companion Location setting attribute value
- Returns:
- S_OK if the User Companion Location setting attribute value
is successfully retrieved, and E_FAIL otherwise
o GetCompanionPathInfo
-
Retrieves the User Companion Location setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The User Companion Location setting attribute information object
- Returns:
- S_OK if the User Companion Location setting attribute
information is successfully retrieved, and E_FAIL otherwise
o GetDocLanguage
public virtual HRESULT GetDocLanguage( | int& | ioLang) = 0 |
-
Retrieves the Technical Documentation Language setting attribute value.
Role: The Technical Documentation Language setting attribute manages the language of the technical documentation
- Parameters:
-
- ioLang
- [inout] The Technical Documentation Language setting attribute value
- Returns:
- S_OK if the Technical Documentation Language setting attribute value
is successfully retrieved, and E_FAIL otherwise
o GetDocLanguageInfo
-
Retrieves the Technical Documentation Language setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The Technical Documentation Language setting attribute information object
- Returns:
- S_OK if the Technical Documentation Language setting attribute
information is successfully retrieved, and E_FAIL otherwise
o GetPriority
public virtual HRESULT GetPriority( | CATDocContextualPriority& | ioPriority) = 0 |
-
Retrieves the Contextual Priority setting attribute value.
Role: The Contextual Priority setting attribute manages the access priority between technical documentation and User Companion
- Parameters:
-
- ioPriority
- [inout] The Contextual Priority setting attribute value
- Returns:
- S_OK if the Contextual Priority setting attribute value
is successfully retrieved, and E_FAIL otherwise
o GetPriorityInfo
-
Retrieves the Contextual Priority setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The Contextual Priority setting attribute information object
- Returns:
- S_OK if the Contextual Priority setting attribute information
is successfully retrieved, and E_FAIL otherwise
o GetTechnicalDocumentationPath
-
Retrieves the Technical Documentation Location setting attribute value.
Role: The Technical Documentation Location setting attribute manages the location or path where the technical documentation is installed
- Parameters:
-
- ioPath
- [inout] The Technical Documentation Location setting attribute value
- Returns:
- S_OK if the Technical Documentation Location setting attribute value
is successfully retrieved, and E_FAIL otherwise
o GetTechnicalDocumentationPathInfo
-
Retrieves the Technical Documentation Location setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The Technical Documentation Location setting attribute information object
- Returns:
- S_OK if the Technical Documentation Location setting attribute
information is successfully retrieved, and E_FAIL otherwise
o SetCompanionPath
-
Sets the User Companion Location setting attribute value.
- Parameters:
-
- iPath
- [in] The User Companion Location setting attribute value.
Legal values: string containing the path where the User Companion is installed
- Returns:
- S_OK if the User Companion Location setting attribute value
is successfully set, and E_FAIL otherwise
o SetCompanionPathLock
public virtual HRESULT SetCompanionPathLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the User Companion Location setting attribute.
Role: Locks or unlocks the User Companion Location setting attribute if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the User Companion Location setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the User Companion Location setting attribute
is successfully locked or unlocked, and E_FAIL otherwise
o SetDocLanguage
public virtual HRESULT SetDocLanguage( | const int& | iLang) = 0 |
-
Sets the Technical Documentation Language setting attribute value.
- Parameters:
-
- iLang
- [in] The Technical Documentation Language setting attribute value.
Legal values: language identifier
- Returns:
- S_OK if the Technical Documentation Language setting attribute value
is successfully set, and E_FAIL otherwise
o SetDocLanguageLock
public virtual HRESULT SetDocLanguageLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Technical Documentation Language setting attribute.
Role: Locks or unlocks the Technical Documentation Language setting attribute if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the Technical Documentation Language setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the Technical Documentation Language setting attribute
is successfully locked or unlocked, and E_FAIL otherwise
o SetPriority
public virtual HRESULT SetPriority( | const CATDocContextualPriority& | iPriority) = 0 |
-
Sets the Contextual Priority setting attribute value.
- Parameters:
-
- iPriority
- [in] The Contextual Priority setting attribute value.
Legal values:
CATDocContextualTechDoc: Technical documentation is launched first
CATDocContextualUserComp: User Companion is launched first
- Returns:
- S_OK if the Contextual Priority setting attribute value
is successfully set, and E_FAIL otherwise
o SetPriorityLock
public virtual HRESULT SetPriorityLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Contextual Priority setting attribute.
Role: Locks or unlocks the Contextual Priority setting attribute if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the Contextual Priority setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the Contextual Priority setting attribute
is successfully locked or unlocked, and E_FAIL otherwise
o SetTechnicalDocumentationPath
-
Sets the Technical Documentation Location setting attribute value.
- Parameters:
-
- iPath
- [in] The Technical Documentation Location setting attribute value.
Legal values: string containing the path where the technical documentation is installed
- Returns:
- S_OK if the Technical Documentation Location setting attribute value
is successfully set, and E_FAIL otherwise
o SetTechnicalDocumentationPathLock
public virtual HRESULT SetTechnicalDocumentationPathLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Technical Documentation Location setting attribute.
Role: Locks or unlocks the Technical Documentation Location setting attribute if the operation is allowed in the current administrated environment.
In user mode this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the Technical Documentation Location setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the Technical Documentation Location setting attribute
is successfully locked or unlocked, and E_FAIL otherwise
This object is included in the file: CATICafDocumentationSettingAtt.h
If needed, your Imakefile.mk should include the module: CATCafDocumentation