All Frameworks  Class Hierarchy  This Framework  Next  Indexes

CATSmInterfaces Interface CATIStmCatalogSHMObjectSettingAtt

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

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


interface CATIStmCatalogSHMObjectSettingAtt

Interface to CATIA Sheet Metal Aerospace General setting controller object.
Role: The CATIA Sheet Metal Aerospace General setting controller is dedicated to manage the setting parameters displayed in the Sheet Metal Aerospace General property page. To access this property page:

Retrieve a pointer to CATIStmCatalogSHMObjectSettingAtt as follows:

 CATIStmCatalogSHMObjectSettingAtt * pIStmCatalogSHMObjectSettingCtrl;
 HRESULT rc = E_FAIL;
 rc = ::CATInstantiateComponent("CATIStmCatalogSHMObjectSettingCtrl",
                                IID_CATIStmCatalogSHMObjectSettingAtt,
                                (void**) & pIStmCatalogSHMObjectSettingCtrl);
 


Method Index


o GetSHMStdProfPath(CATUnicodeString&)
Retrieves the Standard Profile Catalog File setting parameter value.
o GetSHMStdProfPathInfo(CATSettingInfo*)
Retrieves information about the Standard Profile Catalog File setting parameter.
o SetSHMStdProfPath(CATUnicodeString&)
Sets the Standard Profile Catalog File setting parameter value.
o SetSHMStdProfPathLock(unsigned char)
Locks or unlocks the Standard Profile Catalog File parameter.

Methods


o GetSHMStdProfPath
public virtual HRESULT GetSHMStdProfPath(CATUnicodeString& oSHMStdProfPath) = 0
Retrieves the Standard Profile Catalog File setting parameter value.
Role: The Standard Profile Catalog File setting parameter stores the path to the CATIA Catalog file used by the Catalog Browser whenever it is involved in Aerospace Sheet Metal commands, such as cutout or corner relief.
Parameters:
oSHMStdProfPath
[out] a valid path to a CATIA Catalog file
Returns:
S_OK if the Standard Profile Catalog File setting parameter value is successfully retrieved, and E_FAIL otherwise
o GetSHMStdProfPathInfo
public virtual HRESULT GetSHMStdProfPathInfo(CATSettingInfo* oInfo) = 0
Retrieves information about the Standard Profile Catalog File setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetSHMStdProfPath
public virtual HRESULT SetSHMStdProfPath(CATUnicodeString& iSHMStdProfPath) = 0
Sets the Standard Profile Catalog File setting parameter value.
Parameters:
iSHMStdProfPath
[in] The Standard Profile Catalog File setting parameter value.
Legal values: a valid path to a CATIA Catalog file.
Returns:
S_OK if the Standard Profile Catalog File setting parameter value is successfully set, and E_FAIL otherwise
o SetSHMStdProfPathLock
public virtual HRESULT SetSHMStdProfPathLock(unsigned char iLocked) = 0
Locks or unlocks the Standard Profile Catalog File parameter.
Refer to CATSysSettingController for a detailed description.

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

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