All Frameworks Class Hierarchy This Framework Previous Next Indexes
DMAPSInterfaces Interface CATISPPLibTabSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISPPLibTabSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISPPLibTabSettingAtt
Interface to handle the parameters of the Library Tab page.
Role: This interface is implemented by a component which
represents the controller of the Library Tab Page.
This interface defines:
- A method to set each parameter
- A method to get the value of each parameter
- A method to lock/unlock each parameter
- A method to retrieve the informations concerning each parameter
Method Index
- o
GetListOfLibraryFilePath(CATListOfCATUnicodeString&)
- Retrieves a list of libraries that are used in a Process document.
- o
GetListOfLibraryFilePathInfo(CATSettingInfo*)
- Retrieves the state of the parameter.
- o
SetListOfLibraryFilePath(CATListOfCATUnicodeString&)
- Sets a list of libraries that will be used in a Process document.
- o
SetListOfLibraryFilePathLock(unsigned char)
- Locks or unlocks the "List of Libraries" parameter.
Methods
o GetListOfLibraryFilePath
-
Retrieves a list of libraries that are used in a Process document.
Role: Retrieves the list of libraries that are used in a Process document
- Parameters:
-
- ioResFilter
- The output path of the Libraries
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetListOfLibraryFilePathInfo
-
Retrieves the state of the parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetListOfLibraryFilePath
-
Sets a list of libraries that will be used in a Process document.
Role: Sets a list of libraries that will be used in a Process document
- Parameters:
-
- iPath
- The list of libraries that are to be set
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetListOfLibraryFilePathLock
public virtual HRESULT SetListOfLibraryFilePathLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "List of Libraries" parameter.
Role: Locks or unlocks the 'List of Libraries' 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: CATISPPLibTabSettingAtt.h
If needed, your Imakefile.mk should include the module: CATProcessInterfaces