All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATILieReportGenerationSheetSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATILieReportGenerationSheetSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATILieReportGenerationSheetSettingAtt
The interface to access a CATILieReportGenerationSheetSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option the settings values
of Units sheet.
Method Index
- o
GetAllChecksReport(int*)
- Retrieves the AllChecksReport attribute.
- o
GetAllChecksReportInfo(CATSettingInfo*)
- Retrieves the state of the AllChecksReport parameter.
- o
GetCheckReportHtml(int*)
- Retrieves the CheckReportHtml attribute.
- o
GetCheckReportHtmlInfo(CATSettingInfo*)
- Retrieves the state of the CheckReportHtml parameter.
- o
GetDirectoryForInputXsl(CATUnicodeString&)
- Retrieves the DirectoryForInputXsl attribute.
- o
GetDirectoryForInputXslInfo(CATSettingInfo*)
- Retrieves the state of the DirectoryForInputXsl parameter.
- o
GetReportCheckAdvisor(int*)
- Retrieves the ReportCheckAdvisor attribute.
- o
GetReportCheckAdvisorInfo(CATSettingInfo*)
- Retrieves the state of the ReportCheckAdvisor parameter.
- o
GetReportCheckExpert(int*)
- Retrieves the ReportCheckExpert attribute.
- o
GetReportCheckExpertInfo(CATSettingInfo*)
- Retrieves the state of the ReportCheckExpert parameter.
- o
GetReportHtmlInCatiaSession(int*)
- Retrieves the ReportHtmlInCatiaSession attribute.
- o
GetReportHtmlInCatiaSessionInfo(CATSettingInfo*)
- Retrieves the state of the ReportHtmlInCatiaSession parameter.
- o
GetReportObjectsInformation(int*)
- Retrieves the ReportObjectsInformation attribute.
- o
GetReportObjectsInformationInfo(CATSettingInfo*)
- Retrieves the state of the ReportObjectsInformation parameter.
- o
GetReportOutputDirectory(CATUnicodeString&)
- Retrieves the ReportOutputDirectory attribute.
- o
GetReportOutputDirectoryInfo(CATSettingInfo*)
- Retrieves the state of the ReportOutputDirectory parameter.
- o
GetReportParametersInformation(int*)
- Retrieves the ReportParametersInformation attribute.
- o
GetReportParametersInformationInfo(CATSettingInfo*)
- Retrieves the state of the ReportParametersInformation parameter.
- o
GetReportPassedObjects(int*)
- Retrieves the ReportPassedObjects attribute.
- o
GetReportPassedObjectsInfo(CATSettingInfo*)
- Retrieves the state of the ReportPassedObjects parameter.
- o
SetAllChecksReport(int*)
- Sets the AllChecksReport attribute.
- o
SetAllChecksReportLock(unsigned char)
- Locks or unlocks the AllChecksReport parameter.
- o
SetCheckReportHtml(int*)
- Sets the CheckReportHtml attribute.
- o
SetCheckReportHtmlLock(unsigned char)
- Locks or unlocks the CheckReportHtml parameter.
- o
SetDirectoryForInputXsl(CATUnicodeString&)
- Sets the DirectoryForInputXsl attribute.
- o
SetDirectoryForInputXslLock(unsigned char)
- Locks or unlocks the DirectoryForInputXsl parameter.
- o
SetReportCheckAdvisor(int*)
- Sets the ReportCheckAdvisor attribute.
- o
SetReportCheckAdvisorLock(unsigned char)
- Locks or unlocks the ReportCheckAdvisor parameter.
- o
SetReportCheckExpert(int*)
- Sets the ReportCheckExpert attribute.
- o
SetReportCheckExpertLock(unsigned char)
- Locks or unlocks the ReportCheckExpert parameter.
- o
SetReportHtmlInCatiaSession(int*)
- Sets the ReportHtmlInCatiaSession attribute.
- o
SetReportHtmlInCatiaSessionLock(unsigned char)
- Locks or unlocks the ReportHtmlInCatiaSession parameter.
- o
SetReportObjectsInformation(int*)
- Sets the ReportObjectsInformation attribute.
- o
SetReportObjectsInformationLock(unsigned char)
- Locks or unlocks the ReportObjectsInformation parameter.
- o
SetReportOutputDirectory(CATUnicodeString&)
- Sets the ReportOutputDirectory attribute.
- o
SetReportOutputDirectoryLock(unsigned char)
- Locks or unlocks the ReportOutputDirectory parameter.
- o
SetReportParametersInformation(int*)
- Sets the ReportParametersInformation attribute.
- o
SetReportParametersInformationLock(unsigned char)
- Locks or unlocks the ReportParametersInformation parameter.
- o
SetReportPassedObjects(int*)
- Sets the ReportPassedObjects attribute.
- o
SetReportPassedObjectsLock(unsigned char)
- Locks or unlocks the ReportPassedObjects parameter.
Methods
o GetAllChecksReport
public virtual HRESULT GetAllChecksReport( | int* | ioAllChecksReport) = 0 |
-
Retrieves the AllChecksReport attribute.
Role:Return the AllChecksReport parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioAllChecksReport
- Legal values:
0 : report of only failed checks
1 : report of all checks.
o GetAllChecksReportInfo
-
Retrieves the state of the AllChecksReport parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCheckReportHtml
public virtual HRESULT GetCheckReportHtml( | int* | ioCheckReportHtml) = 0 |
-
Retrieves the CheckReportHtml attribute.
Role:Return the CheckReportHtml parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioCheckReportHtml
- Legal values:
0 : to have check report in Xml
1 : to have check report in Html.
o GetCheckReportHtmlInfo
-
Retrieves the state of the CheckReportHtml parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDirectoryForInputXsl
-
Retrieves the DirectoryForInputXsl attribute.
Role:Return the DirectoryForInputXsl parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oDirectoryForInputXsl
- Directory for the report file with Xml extension.
o GetDirectoryForInputXslInfo
-
Retrieves the state of the DirectoryForInputXsl parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportCheckAdvisor
public virtual HRESULT GetReportCheckAdvisor( | int* | ioReportCheckAdvisor) = 0 |
-
Retrieves the ReportCheckAdvisor attribute.
Role:Return the ReportCheckAdvisor parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportCheckAdvisor
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o GetReportCheckAdvisorInfo
-
Retrieves the state of the ReportCheckAdvisor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportCheckExpert
public virtual HRESULT GetReportCheckExpert( | int* | ioReportCheckExpert) = 0 |
-
Retrieves the ReportCheckExpert attribute.
Role:Return the ReportCheckExpert parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportCheckExpert
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o GetReportCheckExpertInfo
-
Retrieves the state of the ReportCheckExpert parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportHtmlInCatiaSession
public virtual HRESULT GetReportHtmlInCatiaSession( | int* | ioReportHtmlInCatiaSession) = 0 |
-
Retrieves the ReportHtmlInCatiaSession attribute.
Role:Return the ReportHtmlInCatiaSession parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportHtmlInCatiaSession
- Legal values:
0 : report Html outside CATIA session
1 : report Html in CATIA session.
o GetReportHtmlInCatiaSessionInfo
-
Retrieves the state of the ReportHtmlInCatiaSession parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportObjectsInformation
public virtual HRESULT GetReportObjectsInformation( | int* | ioReportObjectsInformation) = 0 |
-
Retrieves the ReportObjectsInformation attribute.
Role:Return the ReportObjectsInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportObjectsInformation
- Legal values:
0 : not report objects information
1 : report objects information.
o GetReportObjectsInformationInfo
-
Retrieves the state of the ReportObjectsInformation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportOutputDirectory
-
Retrieves the ReportOutputDirectory attribute.
Role:Return the ReportOutputDirectory parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportOutputDirectory
- The output directory for report of checks expert and checks advisor.
o GetReportOutputDirectoryInfo
-
Retrieves the state of the ReportOutputDirectory parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportParametersInformation
public virtual HRESULT GetReportParametersInformation( | int* | ioReportParametersInformation) = 0 |
-
Retrieves the ReportParametersInformation attribute.
Role:Return the ReportParametersInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportParametersInformation
- Legal values:
0 : not check Advisor parameter information
1 : check Advisor parameter information.
o GetReportParametersInformationInfo
-
Retrieves the state of the ReportParametersInformation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReportPassedObjects
public virtual HRESULT GetReportPassedObjects( | int* | ioReportPassedObjects) = 0 |
-
Retrieves the ReportPassedObjects attribute.
Role:Return the ReportPassedObjects parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioReportPassedObjects
- Legal values:
0 : not report passed objects
1 : report passed objects.
o GetReportPassedObjectsInfo
-
Retrieves the state of the ReportPassedObjects parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAllChecksReport
public virtual HRESULT SetAllChecksReport( | int* | iAllChecksReport) = 0 |
-
Sets the AllChecksReport attribute.
Role:Set the AllChecksReport parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iAllChecksReport
- Legal values:
0 : report of only failed checks
1 : report of all checks.
o SetAllChecksReportLock
public virtual HRESULT SetAllChecksReportLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the AllChecksReport parameter.
Role: Locks or unlocks the AllChecksReport 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 SetCheckReportHtml
public virtual HRESULT SetCheckReportHtml( | int* | iCheckReportHtml) = 0 |
-
Sets the CheckReportHtml attribute.
Role:Set the CheckReportHtml parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iCheckReportHtml
- Legal values:
0 : to have check report in Xml
1 : to have check report in Html.
o SetCheckReportHtmlLock
public virtual HRESULT SetCheckReportHtmlLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the CheckReportHtml parameter.
Role: Locks or unlocks the CheckReportHtml 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 SetDirectoryForInputXsl
-
Sets the DirectoryForInputXsl attribute.
Role:Set the DirectoryForInputXsl parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oDirectoryForInputXsl
- Directory for the report file with Xml extension.
o SetDirectoryForInputXslLock
public virtual HRESULT SetDirectoryForInputXslLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the DirectoryForInputXsl parameter.
Role: Locks or unlocks the DirectoryForInputXsl 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 SetReportCheckAdvisor
public virtual HRESULT SetReportCheckAdvisor( | int* | iReportCheckAdvisor) = 0 |
-
Sets the ReportCheckAdvisor attribute.
Role:Set the ReportCheckAdvisor parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportCheckAdvisor
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o SetReportCheckAdvisorLock
public virtual HRESULT SetReportCheckAdvisorLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ReportCheckAdvisor parameter.
Role: Locks or unlocks the ReportCheckAdvisor 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 SetReportCheckExpert
public virtual HRESULT SetReportCheckExpert( | int* | iReportCheckExpert) = 0 |
-
Sets the ReportCheckExpert attribute.
Role:Set the ReportCheckExpert parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportCheckExpert
- Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o SetReportCheckExpertLock
public virtual HRESULT SetReportCheckExpertLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ReportCheckExpert parameter.
Role: Locks or unlocks the ReportCheckExpert 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 SetReportHtmlInCatiaSession
public virtual HRESULT SetReportHtmlInCatiaSession( | int* | iReportHtmlInCatiaSession) = 0 |
-
Sets the ReportHtmlInCatiaSession attribute.
Role:Set the ReportHtmlInCatiaSession parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportHtmlInCatiaSession
- Legal values:
0 : report Html outside CATIA session
1 : report Html in CATIA session.
o SetReportHtmlInCatiaSessionLock
public virtual HRESULT SetReportHtmlInCatiaSessionLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ReportHtmlInCatiaSession parameter.
Role: Locks or unlocks the ReportHtmlInCatiaSession 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 SetReportObjectsInformation
public virtual HRESULT SetReportObjectsInformation( | int* | iReportObjectsInformation) = 0 |
-
Sets the ReportObjectsInformation attribute.
Role:Set the ReportObjectsInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportObjectsInformation
- Legal values:
0 : not report objects information
1 : report objects information.
o SetReportObjectsInformationLock
public virtual HRESULT SetReportObjectsInformationLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ReportObjectsInformation parameter.
Role: Locks or unlocks the ReportObjectsInformation 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 SetReportOutputDirectory
-
Sets the ReportOutputDirectory attribute.
Role:Set the ReportOutputDirectory parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportOutputDirectory
- The output directory for report of checks expert and checks advisor.
o SetReportOutputDirectoryLock
public virtual HRESULT SetReportOutputDirectoryLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ReportOutputDirectory parameter.
Role: Locks or unlocks the ReportOutputDirectory 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 SetReportParametersInformation
public virtual HRESULT SetReportParametersInformation( | int* | iReportParametersInformation) = 0 |
-
Sets the ReportParametersInformation attribute.
Role:Set the ReportParametersInformation parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportParametersInformation
- Legal values:
0 : not check Advisor parameter information
1 : check Advisor parameter information.
o SetReportParametersInformationLock
public virtual HRESULT SetReportParametersInformationLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ReportParametersInformation parameter.
Role: Locks or unlocks the ReportParametersInformation 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 SetReportPassedObjects
public virtual HRESULT SetReportPassedObjects( | int* | iReportPassedObjects) = 0 |
-
Sets the ReportPassedObjects attribute.
Role:Set the ReportPassedObjects parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iReportPassedObjects
- Legal values:
0 : not report passed objects
1 : report passed objects.
o SetReportPassedObjectsLock
public virtual HRESULT SetReportPassedObjectsLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the ReportPassedObjects parameter.
Role: Locks or unlocks the ReportPassedObjects 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: CATILieReportGenerationSheetSettingAtt.h
If needed, your Imakefile.mk should include the module: KnowledgeItf