All Frameworks Class Hierarchy This Framework Previous Next Indexes
System Interface CATISysGeneralStatisticsSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISysGeneralStatisticsSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISysGeneralStatisticsSettingAtt
Interface to handle the parameters of all the statistics thematics.
Role: This interface is implemented by a component which
contains all the methods and variables available for all the statistics thematics.
One should never use it as a statistics thematic.
This interface defines:
- Methods to set each parameter
- Methods to get the value of each parameter
- A method to lock/unlock all parameters (there is only one lock per thematic)
- A method to retrieve the informations concerning all parameters
Method Index
- o
GetActivation(int*)
- Retrieves the activation state of the thematic.
- o
GetCPUS(CATBoolean&)
- Retrieves the activation state of the cpu time field.
- o
GetCumulationMode(int*)
- Retrieves the cumulation state of the thematic.
- o
GetDateFormat(CATSysStatisticsDateFormat&)
- Retrieves the activation state of the date format field.
- o
GetELPS(CATBoolean&)
- Retrieves the activation state of the elapsed time field.
- o
GetFormatMode(int*,int)
- Retrieves the output format mode of the thematic.
- o
GetHOST(CATBoolean&)
- Retrieves the activation state of the host name field.
- o
GetOutput(int*)
- Retrieves the output format of the thematic.
- o
GetOutputFile(CATUnicodeString*)
- Retrieves the output file of the thematic.
- o
GetOutputFormat(CATSysStatisticsOutputFormat&)
- Retrieves the activation state of the output format field.
- o
GetOutputSettingInfo(CATSettingInfo&)
- Retrieves the CATSettingInfo of the thematic.
- o
GetRTIM(CATBoolean&)
- Retrieves the activation state of the response time field.
- o
GetTHEM(CATBoolean&)
- Retrieves the activation state of the thematic name field.
- o
GetTIME(CATBoolean&)
- Retrieves the activation state of the date and time field.
- o
GetThematicsParameterInfo(CATSettingInfo*)
- Retrieves environment informations for the general statistics parameters.
- o
GetTimeUnit(CATSysStatisticsTimeUnit&)
- Retrieves the activation state of the time unit field.
- o
GetUPID(CATBoolean&)
- Retrieves the activation state of the user pid field.
- o
GetUSER(CATBoolean&)
- Retrieves the activation state of the user name field.
- o
SetActivation(int)
- Sets the activation state of the thematic.
- o
SetCPUS(CATBoolean&)
- Sets the activation state of the cpu time field.
- o
SetCumulationMode(int)
- Sets the value of the cumulation state of the thematic.
- o
SetDateFormat(CATSysStatisticsDateFormat&)
- Sets the activation state of the date format field.
- o
SetELPS(CATBoolean&)
- Sets the activation state of the elapsed time field.
- o
SetFormatMode(int,int)
- Sets the output format mode of the thematic.
- o
SetHOST(CATBoolean&)
- Sets the activation state of the host name field.
- o
SetOutput(int)
- Sets the output format of the thematic.
- o
SetOutputFile(CATUnicodeString)
- Sets the output file of the thematic.
- o
SetOutputFormat(CATSysStatisticsOutputFormat&)
- Sets the activation state of the thematic name field.
- o
SetRTIM(CATBoolean&)
- Sets the activation state of the response time field.
- o
SetTHEM(CATBoolean&)
- Sets the activation state of the thematic name field.
- o
SetTIME(CATBoolean&)
- Sets the activation state of the date and time field.
- o
SetThematicsParameterLock(unsigned char)
- Locks or unlocks the general statistics parameters.
- o
SetTimeUnit(CATSysStatisticsTimeUnit&)
- Sets the activation state of the time unit field.
- o
SetUPID(CATBoolean&)
- Sets the activation state of the user pid field.
- o
SetUSER(CATBoolean&)
- Sets the activation state of the user name field.
Methods
o GetActivation
public virtual HRESULT GetActivation( | int* | oActivatationState)=0 |
-
Retrieves the activation state of the thematic.
Role: Retrieves the activation state of the thematic
- Parameters:
-
- oActivatationState
- Legal values:
1 : activated
0 : not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetCPUS
-
Retrieves the activation state of the cpu time field.
Role: Retrieves the activation state of the cpu time field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetCumulationMode
public virtual HRESULT GetCumulationMode( | int* | oCumulative)=0 |
-
Retrieves the cumulation state of the thematic.
Role: Retrieves the cumulation state of the thematic
- Parameters:
-
- oCumulative
- Legal values:
1 : cumulated
0 : not cumulated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetDateFormat
-
Retrieves the activation state of the date format field.
Role: Retrieves the activation state of the date format field
- Parameters:
-
- oStatus
- Legal values:
StandardDate : default date format
NumericalDate: numerical date format
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetELPS
-
Retrieves the activation state of the elapsed time field.
Role: Retrieves the activation state of the elapsed time field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetFormatMode
public virtual HRESULT GetFormatMode( | int* | oFormatMode, |
| int | flag | =0)=0 |
-
Retrieves the output format mode of the thematic.
Role: Retrieves the output format mode of the thematic.
- Parameters:
-
- oFormatMode
- Legal values:
1 : formated
0 : not formated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetHOST
-
Retrieves the activation state of the host name field.
Role: Retrieves the activation state of the host name field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutput
public virtual HRESULT GetOutput( | int* | oOutputType)=0 |
-
Retrieves the output format of the thematic.
Role: Retrieves the output format of the thematic.
- Parameters:
-
- oOutputType
- Legal values:
1 : console (if available)
2 : file
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutputFile
-
Retrieves the output file of the thematic.
Role: Retrieves the output file of the thematic.
- Parameters:
-
- oOutputFile
- Name of the output file
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutputFormat
-
Retrieves the activation state of the output format field.
Role: Retrieves the activation state of the thematic name field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutputSettingInfo
-
Retrieves the CATSettingInfo of the thematic.
Role: Retrieves the CATSettingInfo of the thematic.(no longer used)
- Parameters:
-
- oCATSettingInfo
- CATSettingInfo returned
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRTIM
-
Retrieves the activation state of the response time field.
Role: Retrieves the activation state of the response time field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetTHEM
-
Retrieves the activation state of the thematic name field.
Role: Retrieves the activation state of the thematic name field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetTIME
-
Retrieves the activation state of the date and time field.
Role: Retrieves the activation state of the date and time field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetThematicsParameterInfo
-
Retrieves environment informations for the general statistics parameters.
Role:Retrieves the state of statistics parameters
in the current environment.
- Parameters:
-
- oCATSettingInfo
- CATSettingInfo returned
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetTimeUnit
-
Retrieves the activation state of the time unit field.
Role: Retrieves the activation state of the time unit field
- Parameters:
-
- iTimeUnit
- Legal values:
Millisecond : durations in milliseconds
Second : durations in seconds
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetUPID
-
Retrieves the activation state of the user pid field.
Role: Retrieves the activation state of the user pid field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetUSER
-
Retrieves the activation state of the user name field.
Role: Retrieves the activation state of the user name field
- Parameters:
-
- oStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetActivation
public virtual HRESULT SetActivation( | int | iActivationState)=0 |
-
Sets the activation state of the thematic.
Role: Retrieves the activation state of the thematic
- Parameters:
-
- oActivatationState
- Legal values:
1 : activated
0 : not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetCPUS
-
Sets the activation state of the cpu time field.
Role: Retrieves the activation state of the cpu time field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetCumulationMode
public virtual HRESULT SetCumulationMode( | int | oCumulative)=0 |
-
Sets the value of the cumulation state of the thematic.
Role: Sets the cumulation state of the thematic
- Parameters:
-
- oCumulative
- Legal values:
1 : cumulated
0 : not cumulated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetDateFormat
-
Sets the activation state of the date format field.
Role: Retrieves the activation state of the date format field
- Parameters:
-
- iStatus
- Legal values:
StandardDate : default date format
NumericalDate: numerical date format
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetELPS
-
Sets the activation state of the elapsed time field.
Role: Retrieves the activation state of the elapsed time field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetFormatMode
public virtual HRESULT SetFormatMode( | int | iFormatMode, |
| int | flag | =0)=0 |
-
Sets the output format mode of the thematic.
Role: Sets the output format mode of the thematic
- Parameters:
-
- iFormatMode
- Legal values:
1 : formated
0 : not formated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetHOST
-
Sets the activation state of the host name field.
Role: Retrieves the activation state of the host name field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetOutput
public virtual HRESULT SetOutput( | int | iOutputType)=0 |
-
Sets the output format of the thematic.
Role: Sets the output format of the thematic
- Parameters:
-
- iOutputType
- Legal values:
1 : console (if available)
2 : file
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetOutputFile
-
Sets the output file of the thematic.
Role: Sets the output file of the thematic
- Parameters:
-
- iOutputFile
- Name of the output file
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetOutputFormat
-
Sets the activation state of the thematic name field.
Role: Retrieves the activation state of the thematic name field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRTIM
-
Sets the activation state of the response time field.
Role: Retrieves the activation state of the response time field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetTHEM
-
Sets the activation state of the thematic name field.
Role: Retrieves the activation state of the thematic name field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetTIME
-
Sets the activation state of the date and time field.
Role: Retrieves the activation state of the date and time field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetThematicsParameterLock
public virtual HRESULT SetThematicsParameterLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the general statistics parameters.
Role:Locks or unlocks the statistics parameters.
- Parameters:
-
- iLock
- the locking operation to be performed
Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetTimeUnit
-
Sets the activation state of the time unit field.
Role: Retrieves the activation state of the time unit field
- Parameters:
-
- iTimeUnit
- Legal values:
Millisecond : durations in milliseconds
Second : durations in seconds
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetUPID
-
Sets the activation state of the user pid field.
Role: Retrieves the activation state of the user pid field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetUSER
-
Sets the activation state of the user name field.
Role: Retrieves the activation state of the user name field
- Parameters:
-
- iStatus
- Legal values:
TRUE : activated
FALSE: not activated
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on Failure
This object is included in the file: CATISysGeneralStatisticsSettingAtt.h
If needed, your Imakefile.mk should include the module: JS0GROUP