All Frameworks  Class Hierarchy  This Framework  Indexes

CATRdgInterfaces Interface CATIRdgRenderingSettingAtt

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

Methods


o GetEngineInterface
public virtual HRESULT GetEngineInterface(CATUnicodeString& ioEngineInterface) = 0
Retrieves the EngineInterface attribute.
o GetEngineInterfaceInfo
public virtual HRESULT GetEngineInterfaceInfo(CATSettingInfo* oInfo) = 0
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 GetOutputHeight
public virtual HRESULT GetOutputHeight(int& ioOutputHeight) = 0
Retrieves the OutputHeight attribute.
o GetOutputHeightInfo
public virtual HRESULT GetOutputHeightInfo(CATSettingInfo* oInfo) = 0
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 GetOutputPath
public virtual HRESULT GetOutputPath(CATUnicodeString& ioOutputPath) = 0
Retrieves the OutputPath attribute.
o GetOutputPathInfo
public virtual HRESULT GetOutputPathInfo(CATSettingInfo* oInfo) = 0
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 GetOutputSizeFrom
public virtual HRESULT GetOutputSizeFrom(int& ioOutputSizeFrom) = 0
Retrieves the OutputSizeFrom attribute.
o GetOutputSizeFromInfo
public virtual HRESULT GetOutputSizeFromInfo(CATSettingInfo* oInfo) = 0
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 GetOutputType
public virtual HRESULT GetOutputType(int& ioOutputType) = 0
Retrieves the OutputType attribute.
o GetOutputTypeInfo
public virtual HRESULT GetOutputTypeInfo(CATSettingInfo* oInfo) = 0
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 GetOutputWidth
public virtual HRESULT GetOutputWidth(int& ioOutputWidth) = 0
Retrieves the OutputWidth attribute.
o GetOutputWidthInfo
public virtual HRESULT GetOutputWidthInfo(CATSettingInfo* oInfo) = 0
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 GetSaveAutoIncrement
public virtual HRESULT GetSaveAutoIncrement(unsigned char& ioSaveAutoIncrement) = 0
Retrieves the SaveAutoIncrement attribute.
o GetSaveAutoIncrementInfo
public virtual HRESULT GetSaveAutoIncrementInfo(CATSettingInfo* oInfo) = 0
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 SetEngineInterface
public virtual HRESULT SetEngineInterface( const CATUnicodeString& iEngineInterface) = 0
Sets the EngineInterface attribute.
o SetEngineInterfaceLock
public virtual HRESULT SetEngineInterfaceLock(unsigned char iLocked) = 0
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 SetOutputHeight
public virtual HRESULT SetOutputHeight(int iOutputHeight) = 0
Sets the OutputHeight attribute.
o SetOutputHeightLock
public virtual HRESULT SetOutputHeightLock(unsigned char iLocked) = 0
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 SetOutputPath
public virtual HRESULT SetOutputPath( const CATUnicodeString& iOutputPath) = 0
Sets the OutputPath attribute.
o SetOutputPathLock
public virtual HRESULT SetOutputPathLock(unsigned char iLocked) = 0
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 SetOutputSizeFrom
public virtual HRESULT SetOutputSizeFrom(int iOutputSizeFrom) = 0
Sets the OutputSizeFrom attribute.
o SetOutputSizeFromLock
public virtual HRESULT SetOutputSizeFromLock(unsigned char iLocked) = 0
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 SetOutputType
public virtual HRESULT SetOutputType(int iOutputType) = 0
Sets the OutputType attribute.
o SetOutputTypeLock
public virtual HRESULT SetOutputTypeLock(unsigned char iLocked) = 0
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 SetOutputWidth
public virtual HRESULT SetOutputWidth(int iOutputWidth) = 0
Sets the OutputWidth attribute.
o SetOutputWidthLock
public virtual HRESULT SetOutputWidthLock(unsigned char iLocked) = 0
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 SetSaveAutoIncrement
public virtual HRESULT SetSaveAutoIncrement(unsigned char iSaveAutoIncrement) = 0
Sets the SaveAutoIncrement attribute.
o SetSaveAutoIncrementLock
public virtual HRESULT SetSaveAutoIncrementLock(unsigned char iLocked) = 0
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

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.