All Frameworks  Class Hierarchy  This Framework  Indexes   

DNBReportingInterfaces Interface DNBIIgpFASReportingSettingAtt

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


interface DNBIIgpFASReportingSettingAtt

Describe the functionality of your interface here.

Using this prefered syntax will enable mkdoc to document your class.


Method Index


o GetDefaultStyleSheetInfo(CATSettingInfo*)
Gets information on "DefaultStyleSheet" parameter.
o GetDefaultStyleSheet(CATUnicodeString&)
Gets value of "DefaultStyleSheet" parameter.
o GetJavaClassPathInfo(CATSettingInfo*)
Gets information on "Java Class Path" parameter.
o GetJavaClassPath(CATUnicodeString&)
Gets value of "Java Class Path" parameter.
o GetJavaExeInfo(CATSettingInfo*)
Gets information on "Java Executable" parameter.
o GetJavaExe(CATUnicodeString&)
Gets value of "Java Executable" parameter.
o GetResultOutputDirInfo(CATSettingInfo*)
Gets information on "Java Class Path" parameter.
o GetResultOutputDir(CATUnicodeString&)
Gets value of "Java Class Path" parameter.
o GetSVGViewerInfo(CATSettingInfo*)
Gets information on "Java Class Path" parameter.
o GetSVGViewer(int&)
Gets the type of SVG Viewer
o GetStyleSheetDirInfo(CATSettingInfo*)
Gets information on "Style Sheet directory" parameter.
o GetStyleSheetDir(CATUnicodeString&)
Gets value of "Style Sheet directory" parameter.
o SetDefaultStyleSheetLock(unsigned char)
Locks or unlocks the "DefaultStyleSheet" parameter.
o SetDefaultStyleSheet(CATUnicodeString&)
Sets value of "DefaultStyleSheet" parameter.
o SetJavaClassPathLock(unsigned char)
Locks or unlocks the "Java Class Path" parameter.
o SetJavaClassPath(CATUnicodeString&)
Sets value of "Java Class Path" parameter.
o SetJavaExeLock(unsigned char)
Locks or unlocks the "Java Executable" parameter.
o SetJavaExe(CATUnicodeString&)
Sets value of "Java Executable" parameter.
o SetResultOutputDirLock(unsigned char)
Locks or unlocks the "Java Class Path" parameter.
o SetResultOutputDir(CATUnicodeString&)
Sets value of "Java Class Path" parameter.
o SetSVGViewerLock(unsigned char)
Locks or unlocks the "Java Class Path" parameter.
o SetSVGViewer(int&)
Sets the type of SVG Viewer
o SetStyleSheetDirLock(unsigned char)
Locks or unlocks the "Style Sheet directory" parameter.
o SetStyleSheetDir(CATUnicodeString&)
Sets value of "Style Sheet directory" parameter.

Methods


o GetDefaultStyleSheetInfo
public virtual GetDefaultStyleSheetInfo( oInfo)
Gets information on "DefaultStyleSheet" parameter.
Role: Gets information on "DefaultStyleSheet" parameter
Parameters:
oInfo
Variable to return information in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetDefaultStyleSheet
public virtual GetDefaultStyleSheet( oDefaultStyleSheet)
Gets value of "DefaultStyleSheet" parameter.
Role: Gets value of "DefaultStyleSheet" parameter
Parameters:
oDnldDir
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetJavaClassPathInfo
public virtual GetJavaClassPathInfo( oInfo)
Gets information on "Java Class Path" parameter.
Role: Gets information on "Java Class Path" parameter
Parameters:
oInfo
Variable to return information in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetJavaClassPath
public virtual GetJavaClassPath( oJavaClassPath)
Gets value of "Java Class Path" parameter.
Role: Gets value of "Java Class Path" parameter
Parameters:
o
JavaClassPath Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetJavaExeInfo
public virtual GetJavaExeInfo( oInfo)
Gets information on "Java Executable" parameter.
Role: Gets information on "Java Executable" parameter
Parameters:
oInfo
Variable to return information in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetJavaExe
public virtual GetJavaExe( oJavaExe)
Gets value of "Java Executable" parameter.
Role: Gets value of "Java Executable" parameter
Parameters:
oJavaExe
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetResultOutputDirInfo
public virtual GetResultOutputDirInfo( oInfo)
Gets information on "Java Class Path" parameter.
Role: Gets information on "Java Class Path" parameter
Parameters:
oInfo
Variable to return information in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetResultOutputDir
public virtual GetResultOutputDir( oResultOutputDir)
Gets value of "Java Class Path" parameter.
Role: Gets value of "Java Class Path" parameter
Parameters:
o
JavaClassPath Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetSVGViewerInfo
public virtual GetSVGViewerInfo( oInfo)
Gets information on "Java Class Path" parameter.
Role: Gets information on "Java Class Path" parameter
Parameters:
oInfo
Variable to return information in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetSVGViewer
public virtual GetSVGViewer( osvgViewer)
Gets the type of SVG Viewer
Parameters:
isvgViewer
type of svg viewer to be used Legal values:
1 : Internet Explorer- user needs to have plugin
0: Default viewer (DELIMA SVG Viewer)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetStyleSheetDirInfo
public virtual GetStyleSheetDirInfo( oStyleSheetDir)
Gets information on "Style Sheet directory" parameter.
Role: Gets information on "OLP Java Executable" parameter
Parameters:
oInfo
Variable to return information in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetStyleSheetDir
public virtual GetStyleSheetDir( oStyleSheetDir)
Gets value of "Style Sheet directory" parameter.
Role: Gets value of "OLP Java Executable" parameter
Parameters:
oJavaExe
Variable to return value in.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetDefaultStyleSheetLock
public virtual SetDefaultStyleSheetLock( iLocked)
Locks or unlocks the "DefaultStyleSheet" parameter.
Role: Locks or unlocks the "DefaultStyleSheet" 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 SetDefaultStyleSheet
public virtual SetDefaultStyleSheet( const iDefaultStyleSheet)
Sets value of "DefaultStyleSheet" parameter.
Role: Sets value of "DefaultStyleSheet" parameter
Parameters:
iDnldDir
New value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetJavaClassPathLock
public virtual SetJavaClassPathLock( iLocked)
Locks or unlocks the "Java Class Path" parameter.
Role: Locks or unlocks the "Java Class Path" 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 SetJavaClassPath
public virtual SetJavaClassPath( const iJavaClassPath)
Sets value of "Java Class Path" parameter.
Role: Sets value of "Java Class Path" parameter
Parameters:
i
JavaClassPath New value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetJavaExeLock
public virtual SetJavaExeLock( iLocked)
Locks or unlocks the "Java Executable" parameter.
Role: Locks or unlocks the "Java Executable" 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 SetJavaExe
public virtual SetJavaExe( const iJavaExe)
Sets value of "Java Executable" parameter.
Role: Sets value of "Java Executable" parameter
Parameters:
iJavaExe
New value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetResultOutputDirLock
public virtual SetResultOutputDirLock( iLocked)
Locks or unlocks the "Java Class Path" parameter.
Role: Locks or unlocks the "Java Class Path" 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 SetResultOutputDir
public virtual SetResultOutputDir( const iResultOutputDir)
Sets value of "Java Class Path" parameter.
Role: Sets value of "Java Class Path" parameter
Parameters:
i
JavaClassPath New value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetSVGViewerLock
public virtual SetSVGViewerLock( iLocked)
Locks or unlocks the "Java Class Path" parameter.
Role: Locks or unlocks the "Java Class Path" 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 SetSVGViewer
public virtual SetSVGViewer( isvgViewer)
Sets the type of SVG Viewer
Parameters:
isvgViewer
type of svg viewer to be used Legal values:
1 : Internet Explorer- user needs to have plugin
0: Default viewer (DELIMA SVG Viewer)
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetStyleSheetDirLock
public virtual SetStyleSheetDirLock( iLocked)
Locks or unlocks the "Style Sheet directory" parameter.
Role: Locks or unlocks the "OLP Java Executable" 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 SetStyleSheetDir
public virtual SetStyleSheetDir( const iStyleSheetDir)
Sets value of "Style Sheet directory" parameter.
Role: Sets value of "OLP Java Executable" parameter
Parameters:
iJavaExe
New value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure

This object is included in the file: DNBIIgpFASReportingSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBReportingItf

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