All Frameworks Class Hierarchy This Framework Previous Indexes
DNBMHIInterfaces Interface DNBIMHISaveAccess
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---DNBIMHISaveAccess
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DNBIMHISaveAccess
Interface representing a means to
(1) Save data to the Hub
(2) Retrieve certain information on the loaded document
DNBIMHISaveAccess is implemented on CATDocument.
Applications and CAA partners should NOT implement this interface.
- Example:
-
// *********************************
// Example: Saving a Loaded Document
// *********************************
CATDocument * pLoadedDocument = ... ;
if (pLoadedDocument)
{
DNBIMHISaveAccess * pSaveAccess = NULL;
HRESULT RC = pLoadedDocument->QueryInterface(IID_DNBIMHISaveAccess,
(void**) &pSaveAccess);
if (SUCCEEDED(RC) && NULL != pSaveAccess)
{
CATUnicodeString uDetailingName = "Detailing for Workplan A";
CATBoolean bOverwriteDetailing = TRUE;
CATListOfCATUnicodeString ListErrorMessages;
RC = pSaveAccess->SaveToPPRHub( uDetailingName,
bOverwriteDetailing, ListErrorMessages );
pSaveAccess->Release();
pSaveAccess = NULL;
} // if (SUCCEEDED(RC) && NULL != pSaveAccess)
} // if (pLoadedDocument)
Method Index
- o
GetDetailingNames(CATUnicodeString&,CATListOfCATUnicodeString&)
- Gets the name of the currently loaded detailing and the names
of all the other detailings that exist for the loaded object
- o
GetLoadParameters(DNBIMHILoadParameters*&)
- Gets the interface pointed to the Load Parameters object that contains
all the information pertaining to the load of the document
- o
SaveToPPRHub(CATUnicodeString&,CATBoolean&,CATListOfCATUnicodeString&)
- This method saves a document from V5 to the PPR Hub
Note: All Tools->Options settings will be respected during the save
Methods
o GetDetailingNames
-
Gets the name of the currently loaded detailing and the names
of all the other detailings that exist for the loaded object
- Parameters:
-
- oCurrentlyLoadedDetailing
- [out] The name of the currently loaded detailing.
This will be empty if no detailing was loaded
- oListDetailingNames
- [out] The names of all the detailings that exist on the loaded object
- Returns:
-
S_OK
if names returned OK
S_FALSE
if no detailings exist for the loaded object
E_FAIL
on error
o GetLoadParameters
-
Gets the interface pointed to the Load Parameters object that contains
all the information pertaining to the load of the document
- Parameters:
-
- oLoadParameters
- [out] Interface pointer to the Load Parameters object. This must be
released after use (As per normal interface lifecycle rules)
- Returns:
-
S_OK
if everything ran OK
E_FAIL
on error
o SaveToPPRHub
-
This method saves a document from V5 to the PPR Hub
Note: All Tools->Options settings will be respected during the save
- Parameters:
-
- iDetailingName
- [in] The name of the detailing to save
Note: If the Tools->Options 'Save Without Detailing' is checked ON,
then NO detailing will be saved. This argument will be ignored and only the
exposed data will be saved to the Hub
- iOverwriteDetailing
- [in] Option to indicate if a detailing with the same name needs to overwritten
If this argument is FALSE and a detailing with the same name exists, then
the save will be aborted (Neither detailing nor exposed data will be saved)
- oListErrorMessages
- [out] List of error messages about invalid or incorrect arguments (for example
Tools->Options settings conflicting with input arguments to method).
Note: This will not contain the error messages that occured during
the save (for e.g., failure to save an object/relation in the database)
- Returns:
-
S_OK
if everything ran OK
E_FAIL
on error
This object is included in the file: DNBIMHISaveAccess.h
If needed, your Imakefile.mk should include the module: CAADNBPDMItf