All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

StructureInterfaces Interface CATIStrPathESSRessourcesSettingAtt

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

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


interface CATIStrPathESSRessourcesSettingAtt

Describe the SFDctionality of your interface here.

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


Method Index


o GetResolvedSectionsPath(CATUnicodeString&)
Retrieves the ResolvedSectionsPath attribute.
o GetResolvedSectionsPathInfo(CATSettingInfo*)
Retrieves the state of the ResolvedSectionsPath parameter.
o GetSectionsCatalogPath(CATUnicodeString&)
Retrieves the SectionsCatalogPath attribute.
o GetSectionsCatalogPathInfo(CATSettingInfo*)
Retrieves the state of the SectionsCatalogPath parameter.
o GetThicknessListPath(CATUnicodeString&)
Retrieves the ThicknessListPath attribute.
o GetThicknessListPathInfo(CATSettingInfo*)
Retrieves the state of the ThicknessListPath parameter.
o SetResolvedSectionsPath(CATUnicodeString&)
Sets the ResolvedSectionsPath attribute.
o SetResolvedSectionsPathLock(unsigned char)
Locks or unlocks the ResolvedSectionsPath parameter.
o SetSectionsCatalogPath(CATUnicodeString&)
Sets the SectionsCatalogPath attribute.
o SetSectionsCatalogPathLock(unsigned char)
Locks or unlocks the SectionsCatalogPath parameter.
o SetThicknessListPath(CATUnicodeString&)
Sets the ThicknessListPath attribute.
o SetThicknessListPathLock(unsigned char)
Locks or unlocks the ThicknessListPath parameter.

Methods


o GetResolvedSectionsPath
public virtual HRESULT GetResolvedSectionsPath(CATUnicodeString& oResolvedSectionsPath)= 0
Retrieves the ResolvedSectionsPath attribute.
o GetResolvedSectionsPathInfo
public virtual HRESULT GetResolvedSectionsPathInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the ResolvedSectionsPath parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSectionsCatalogPath
public virtual HRESULT GetSectionsCatalogPath(CATUnicodeString& oSectionsCatalogPath)= 0
Retrieves the SectionsCatalogPath attribute.
o GetSectionsCatalogPathInfo
public virtual HRESULT GetSectionsCatalogPathInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the SectionsCatalogPath parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetThicknessListPath
public virtual HRESULT GetThicknessListPath(CATUnicodeString& oThicknessListPath)= 0
Retrieves the ThicknessListPath attribute.
o GetThicknessListPathInfo
public virtual HRESULT GetThicknessListPathInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the ThicknessListPath parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetResolvedSectionsPath
public virtual HRESULT SetResolvedSectionsPath(CATUnicodeString& iResolvedSectionsPath)= 0
Sets the ResolvedSectionsPath attribute.
o SetResolvedSectionsPathLock
public virtual HRESULT SetResolvedSectionsPathLock(unsigned char iLocked)= 0
Locks or unlocks the ResolvedSectionsPath parameter.
Role: Locks or unlocks the ResolvedSectionsPath 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 SetSectionsCatalogPath
public virtual HRESULT SetSectionsCatalogPath(CATUnicodeString& iSectionsCatalogPath)= 0
Sets the SectionsCatalogPath attribute.
o SetSectionsCatalogPathLock
public virtual HRESULT SetSectionsCatalogPathLock(unsigned char iLocked)= 0
Locks or unlocks the SectionsCatalogPath parameter.
Role: Locks or unlocks the SectionsCatalogPath 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 SetThicknessListPath
public virtual HRESULT SetThicknessListPath(CATUnicodeString& iThicknessListPath)= 0
Sets the ThicknessListPath attribute.
o SetThicknessListPathLock
public virtual HRESULT SetThicknessListPathLock(unsigned char iLocked)= 0
Locks or unlocks the ThicknessListPath parameter.
Role: Locks or unlocks the ThicknessListPath 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: CATIStrPathESSRessourcesSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf

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