All Frameworks  Class Hierarchy  This Framework  Indexes   

StructureInterfaces Interface 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 GetResolvedSectionsPathInfo(CATSettingInfo*)
Retrieves the state of the ResolvedSectionsPath parameter.
o GetResolvedSectionsPath(CATUnicodeString&)
Retrieves the ResolvedSectionsPath attribute.
o GetSectionsCatalogPathInfo(CATSettingInfo*)
Retrieves the state of the SectionsCatalogPath parameter.
o GetSectionsCatalogPath(CATUnicodeString&)
Retrieves the SectionsCatalogPath attribute.
o GetThicknessListPathInfo(CATSettingInfo*)
Retrieves the state of the ThicknessListPath parameter.
o GetThicknessListPath(CATUnicodeString&)
Retrieves the ThicknessListPath attribute.
o SetResolvedSectionsPathLock(unsigned char)
Locks or unlocks the ResolvedSectionsPath parameter.
o SetResolvedSectionsPath(CATUnicodeString&)
Sets the ResolvedSectionsPath attribute.
o SetSectionsCatalogPathLock(unsigned char)
Locks or unlocks the SectionsCatalogPath parameter.
o SetSectionsCatalogPath(CATUnicodeString&)
Sets the SectionsCatalogPath attribute.
o SetThicknessListPathLock(unsigned char)
Locks or unlocks the ThicknessListPath parameter.
o SetThicknessListPath(CATUnicodeString&)
Sets the ThicknessListPath attribute.

Methods


o GetResolvedSectionsPathInfo
public virtual GetResolvedSectionsPathInfo( oInfo)
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 GetResolvedSectionsPath
public virtual GetResolvedSectionsPath( oResolvedSectionsPath)
Retrieves the ResolvedSectionsPath attribute.
o GetSectionsCatalogPathInfo
public virtual GetSectionsCatalogPathInfo( oInfo)
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 GetSectionsCatalogPath
public virtual GetSectionsCatalogPath( oSectionsCatalogPath)
Retrieves the SectionsCatalogPath attribute.
o GetThicknessListPathInfo
public virtual GetThicknessListPathInfo( oInfo)
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 GetThicknessListPath
public virtual GetThicknessListPath( oThicknessListPath)
Retrieves the ThicknessListPath attribute.
o SetResolvedSectionsPathLock
public virtual SetResolvedSectionsPathLock( iLocked)
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 SetResolvedSectionsPath
public virtual SetResolvedSectionsPath( iResolvedSectionsPath)
Sets the ResolvedSectionsPath attribute.
o SetSectionsCatalogPathLock
public virtual SetSectionsCatalogPathLock( iLocked)
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 SetSectionsCatalogPath
public virtual SetSectionsCatalogPath( iSectionsCatalogPath)
Sets the SectionsCatalogPath attribute.
o SetThicknessListPathLock
public virtual SetThicknessListPathLock( iLocked)
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
o SetThicknessListPath
public virtual SetThicknessListPath( iThicknessListPath)
Sets the ThicknessListPath attribute.

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.