All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPDMBaseInterfaces Interface CATIPDMUEAllowDocumentLoading
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPDMUEAllowDocumentLoading
Usage: you can freely reimplement this interface.
interface CATIPDMUEAllowDocumentLoading
Interface to enable some user specific size-check operations on the document/s for load.
Role: This interface is a user exit allowing a user to ensure whether the selected
document/s can be loaded or not subject to memeory considerations.
You should implement it on the CATIPDMUEAllowDocumentLoading component by using
the CATObject mechanism.
NOTE - The Late-type to be used by the customer to implement this interface is "VPM1_AllowDocLoad".
Method Index
- o
AllowDocumentLoading(int,CATIDocId**,double**)
- Allows the user to estimate whether the present system resoursces are enough to load the desired document/s.
Methods
o AllowDocumentLoading
public virtual HRESULT AllowDocumentLoading( | int | iNbDocs, |
| CATIDocId** | iListDocIds, |
| double** | ipDocSize)=0 |
-
Allows the user to estimate whether the present system resoursces are enough to load the desired document/s.
Role: This method will allow the user to compare the system memory resources with the memory
required to load the desired document/s and decide whether the documents can be loaded.
- Parameters:
-
- NbDocs
- -- the number of documents to be loaded. The document to check.
- iListDocIds
- list of the Ids of the documents for load.
- ipDocSize
- -- Size of the documents to be loaded.
Legal values:
- S_OK It is allowed to load the desired document/s.
- S_FALSE It's not allowed to load the desired document/s.
- Returns:
-
- S_OK: execution successful
- E_FAIL: The method has failed. A
CATError class instance is generated.
This object is included in the file: CATIPDMUEAllowDocumentLoading.h
If needed, your Imakefile.mk should include the module: CATPDMBaseItf