All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATISysGlobalStatisticsSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISysGlobalStatisticsSettingAtt
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISysGlobalStatisticsSettingAtt

Interface to handle the parameters of the global statistic.
Role: This interface is implemented by a component which represents the controller of the global statistic.
This interface defines:


Method Index


o GetBufferSize(unsigned int*)
Retrieves the value of the buffer maximum size.
o GetCopyDirectory(CATUnicodeString*)
Retrieves the copy files directory.
o GetMaxCopyFile(unsigned int*)
Retrieves the value of the copy files maximum number.
o GetMaxSizePerFile(unsigned int*)
Retrieves the value of the file maximum size.
o GetThematicsParameterInfo(CATSettingInfo*)
Retrieves the state of the global statistic parameters.
o SetBufferSize(unsigned int)
Sets the value of the buffer maximum size.
o SetCopyDirectory(CATUnicodeString*)
Sets the copy files directory.
o SetMaxCopyFile(unsigned int)
Sets the value of the copy files maximum number.
o SetMaxSizePerFile(unsigned int)
Sets the value of the file maximum size.
o SetThematicsParameterLock(unsigned char)
Locks or unlocks the global statistic parameters.

Methods


o GetBufferSize
public virtual HRESULT GetBufferSize(unsigned int* oSize)=0
Retrieves the value of the buffer maximum size.
Role: Retrieves the value of the buffer maximum size in Mo
Parameters:
oSize
The maximum allowed size of the buffer in Mo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCopyDirectory
public virtual HRESULT GetCopyDirectory(CATUnicodeString* oCopyDir)=0
Retrieves the copy files directory.
Role: Retrieves the path of the copy files directory
Parameters:
oCopyDir
The path of the copy files directory.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMaxCopyFile
public virtual HRESULT GetMaxCopyFile(unsigned int* oNb)=0
Retrieves the value of the copy files maximum number.
Role: Retrieves the value of the copy file maximum number
Parameters:
oNb
The maximum allowed number of copies.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMaxSizePerFile
public virtual HRESULT GetMaxSizePerFile(unsigned int* oSize)=0
Retrieves the value of the file maximum size.
Role: Retrieves the value of the statistics file maximum size in Mo
Parameters:
oSize
The maximum allowed size of the file in Mo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetThematicsParameterInfo
public virtual HRESULT GetThematicsParameterInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the global statistic parameters.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBufferSize
public virtual HRESULT SetBufferSize(unsigned int iSize)=0
Sets the value of the buffer maximum size.
Role: Sets the value of the buffer maximum size in Mo
Parameters:
iSize
The maximum allowed size of the buffer in Mo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCopyDirectory
public virtual HRESULT SetCopyDirectory(CATUnicodeString* iCopyDir)=0
Sets the copy files directory.
Role: Sets the path of the copy files directory
Parameters:
iCopyDir
The path of the copy files directory.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMaxCopyFile
public virtual HRESULT SetMaxCopyFile(unsigned int iNb)=0
Sets the value of the copy files maximum number.
Role: Sets the value of the copy file maximum number
Parameters:
iNb
The maximum allowed number of copies.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMaxSizePerFile
public virtual HRESULT SetMaxSizePerFile(unsigned int iSize)=0
Sets the value of the file maximum size.
Role: Sets the value of the statistics file maximum size in Mo
Parameters:
iSize
The maximum allowed size of the file in Mo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetThematicsParameterLock
public virtual HRESULT SetThematicsParameterLock(unsigned char Lock)=0
Locks or unlocks the global statistic parameters.
Role: Locks or unlocks the global statistic parameters. if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
Lock
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: CATISysGlobalStatisticsSettingAtt.h
If needed, your Imakefile.mk should include the module: JS0GROUP

Copyright © 2003, Dassault Systèmes. All rights reserved.