All Frameworks  Class Hierarchy  This Framework  Indexes   

CATRdgInterfaces Interface CATIRdgRenderingSettingAtt

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


interface CATIRdgRenderingSettingAtt

Interface for PHS settings access.


Method Index


o GetEngineInterfaceInfo(CATSettingInfo*)
Retrieves the state of the EngineInterface parameter.
o GetEngineInterface(CATUnicodeString&)
Retrieves the EngineInterface attribute.
o GetOutputHeightInfo(CATSettingInfo*)
Retrieves the state of the OutputHeight parameter.
o GetOutputHeight(int&)
Retrieves the OutputHeight attribute.
o GetOutputPathInfo(CATSettingInfo*)
Retrieves the state of the OutputPath parameter.
o GetOutputPath(CATUnicodeString&)
Retrieves the OutputPath attribute.
o GetOutputSizeFromInfo(CATSettingInfo*)
Retrieves the state of the OutputSizeFrom parameter.
o GetOutputSizeFrom(int&)
Retrieves the OutputSizeFrom attribute.
o GetOutputTypeInfo(CATSettingInfo*)
Retrieves the state of the OutputType parameter.
o GetOutputType(int&)
Retrieves the OutputType attribute.
o GetOutputWidthInfo(CATSettingInfo*)
Retrieves the state of the OutputWidth parameter.
o GetOutputWidth(int&)
Retrieves the OutputWidth attribute.
o GetSaveAutoIncrementInfo(CATSettingInfo*)
Retrieves the state of the SaveAutoIncrement parameter.
o GetSaveAutoIncrement(unsigned char&)
Retrieves the SaveAutoIncrement attribute.
o SetEngineInterfaceLock(unsigned char)
Locks or unlocks the EngineInterface parameter.
o SetEngineInterface(CATUnicodeString&)
Sets the EngineInterface attribute.
o SetOutputHeightLock(unsigned char)
Locks or unlocks the OutputHeight parameter.
o SetOutputHeight(int)
Sets the OutputHeight attribute.
o SetOutputPathLock(unsigned char)
Locks or unlocks the OutputPath parameter.
o SetOutputPath(CATUnicodeString&)
Sets the OutputPath attribute.
o SetOutputSizeFromLock(unsigned char)
Locks or unlocks the OutputSizeFrom parameter.
o SetOutputSizeFrom(int)
Sets the OutputSizeFrom attribute.
o SetOutputTypeLock(unsigned char)
Locks or unlocks the OutputType parameter.
o SetOutputType(int)
Sets the OutputType attribute.
o SetOutputWidthLock(unsigned char)
Locks or unlocks the OutputWidth parameter.
o SetOutputWidth(int)
Sets the OutputWidth attribute.
o SetSaveAutoIncrementLock(unsigned char)
Locks or unlocks the SaveAutoIncrement parameter.
o SetSaveAutoIncrement(unsigned char)
Sets the SaveAutoIncrement attribute.

Methods


o GetEngineInterfaceInfo
public virtual GetEngineInterfaceInfo( oInfo)
Retrieves the state of the EngineInterface parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetEngineInterface
public virtual GetEngineInterface( ioEngineInterface)
Retrieves the EngineInterface attribute.
o GetOutputHeightInfo
public virtual GetOutputHeightInfo( oInfo)
Retrieves the state of the OutputHeight parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetOutputHeight
public virtual GetOutputHeight( ioOutputHeight)
Retrieves the OutputHeight attribute.
o GetOutputPathInfo
public virtual GetOutputPathInfo( oInfo)
Retrieves the state of the OutputPath parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetOutputPath
public virtual GetOutputPath( ioOutputPath)
Retrieves the OutputPath attribute.
o GetOutputSizeFromInfo
public virtual GetOutputSizeFromInfo( oInfo)
Retrieves the state of the OutputSizeFrom parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetOutputSizeFrom
public virtual GetOutputSizeFrom( ioOutputSizeFrom)
Retrieves the OutputSizeFrom attribute.
o GetOutputTypeInfo
public virtual GetOutputTypeInfo( oInfo)
Retrieves the state of the OutputType parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetOutputType
public virtual GetOutputType( ioOutputType)
Retrieves the OutputType attribute.
o GetOutputWidthInfo
public virtual GetOutputWidthInfo( oInfo)
Retrieves the state of the OutputWidth parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetOutputWidth
public virtual GetOutputWidth( ioOutputWidth)
Retrieves the OutputWidth attribute.
o GetSaveAutoIncrementInfo
public virtual GetSaveAutoIncrementInfo( oInfo)
Retrieves the state of the SaveAutoIncrement parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSaveAutoIncrement
public virtual GetSaveAutoIncrement( ioSaveAutoIncrement)
Retrieves the SaveAutoIncrement attribute.
o SetEngineInterfaceLock
public virtual SetEngineInterfaceLock( iLocked)
Locks or unlocks the EngineInterface parameter.
Role: Locks or unlocks the EngineInterface 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 SetEngineInterface
public virtual SetEngineInterface( const iEngineInterface)
Sets the EngineInterface attribute.
o SetOutputHeightLock
public virtual SetOutputHeightLock( iLocked)
Locks or unlocks the OutputHeight parameter.
Role: Locks or unlocks the OutputHeight 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 SetOutputHeight
public virtual SetOutputHeight( iOutputHeight)
Sets the OutputHeight attribute.
o SetOutputPathLock
public virtual SetOutputPathLock( iLocked)
Locks or unlocks the OutputPath parameter.
Role: Locks or unlocks the OutputPath 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 SetOutputPath
public virtual SetOutputPath( const iOutputPath)
Sets the OutputPath attribute.
o SetOutputSizeFromLock
public virtual SetOutputSizeFromLock( iLocked)
Locks or unlocks the OutputSizeFrom parameter.
Role: Locks or unlocks the OutputSizeFrom 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 SetOutputSizeFrom
public virtual SetOutputSizeFrom( iOutputSizeFrom)
Sets the OutputSizeFrom attribute.
o SetOutputTypeLock
public virtual SetOutputTypeLock( iLocked)
Locks or unlocks the OutputType parameter.
Role: Locks or unlocks the OutputType 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 SetOutputType
public virtual SetOutputType( iOutputType)
Sets the OutputType attribute.
o SetOutputWidthLock
public virtual SetOutputWidthLock( iLocked)
Locks or unlocks the OutputWidth parameter.
Role: Locks or unlocks the OutputWidth 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 SetOutputWidth
public virtual SetOutputWidth( iOutputWidth)
Sets the OutputWidth attribute.
o SetSaveAutoIncrementLock
public virtual SetSaveAutoIncrementLock( iLocked)
Locks or unlocks the SaveAutoIncrement parameter.
Role: Locks or unlocks the SaveAutoIncrement 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 SetSaveAutoIncrement
public virtual SetSaveAutoIncrement( iSaveAutoIncrement)
Sets the SaveAutoIncrement attribute.

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

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