PLMSRMExposedServices CATPLMDetachServices

Usage: you must use this class as is. You should never derive it.

public class CATPLMDetachServices

Class representing services to detach data from the database.

Role: OEM & supplier exchange 3dxml with authoring or PLMBriefcase files with authoring information, thanks to Export and Import functionalities. When data is imported “as reference” in a database, the importing site does not have ownership on the imported data (unless explicitly transferred). CATPLMDetachServices class provides an API to enable the user to remove from the database, the data not owned by the importing site. The data is not deleted. It is just removed. It is always possible to import the data again into the database.

Example:

 
 CATListPtrCATIAdpPLMIdentificator listOfDataToRemove;
 listOfDataToRemove.Append();… //add the elements to remove
 .
 .
 .
 HRESULT Rc = CATPLMDetachServices::Detach(listOfDataToRemove);
 

Method Index

o Detach(CATListPtrCATIAdpPLMIdentificator&)

Detach data from the Database.

Methods

Detach data from the Database.
Role: Removes the list of product structures, not owned by the current site, from the database. Following rules are observed while detaching any component:

1. Detach operation is propagated to all aggregated objects, ie. aggregated instances (representation and product), aggregated representations, connections, ports.
2. Detach of reference (representation and product) detaches all the instances of the reference.

Parameters:

iRootRefIds

[in] List of identificators of the roots of the product structures to be detached.

Returns:

An HRESULT value.
Legal values:

S_OK

Operation succeeded.

E_FAIL

Operation failed. This could be because of following reasons:

1. At least one of the objects being detached is owned by the local site.
2. At least one of the objects being detached is already open for edition in the session.
3. User does not have rights to detach object.
4. The input list contains an aggregated representation/mandatory representation.
   Note: Aggregated representations and mandatory representations are detached when the product aggregating them is detached. Aggregated representations should not be given as input to the API.

Use CATGetLastError() to retrieve error message.

E_INVALIDARG

The input list is empty or the objects in the list are not saved in the database.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.