IDSSSourceManipulatorCallBack Interface Reference

List of all members.

---

Detailed Description

An call back interface defining several methods to process the contents of delta files.

The instance of the interface is passed in IDSSSourceManipulator::ReadFile, and the methods of it will be called by the code reading delta files. The client code should implement this interface to do what it want.

Public Member Functions
HRESULT	DeleteObject ([in] BSTR iID,[in] EnumDSSObjectType iType,[in] BSTR iProjectID)
	Method to deal with an extended object with instruction "delete".
HRESULT	LoadConflictRule ([in] EnumDSSConflictDomain iDomain,[in] VARIANT *iSpecificDomain,[in] EnumDSSSourceFlags iParts,[in] EnumDSSConflictResolution iResolution)
	Method to deal with a conflict rule.
HRESULT	ManifestDependency ([in] IDSSExtendedReference *ipSourceReference,[in] IDSSExtendedReference *ipDestinationReference,[in] IDSSExtendedData *ipExtraData)
	Report relevant dependencies between 2 objects in the dependents manifest.
HRESULT	ManifestObject ([in] IDSSExtendedReference *ipObjectReference,[in] IDSSExtendedData *ipExtraData)
	Report an object in the dependents manifest.
HRESULT	MergeObject ([in] IDSSExtendedObject *ipExtended)
	Method to deal with a single extended object with instruction "merge".
HRESULT	MergeObjects ([in] IDSSExtendedObjects *ipExtended)
	Method to deal with a collection of extended objects with instruction "merge".
HRESULT	ReportPreamble ([in] Int32 iVersionNumber,[in] BSTR iFileID,[in] BSTR iMDVersion,[in] BSTR iSchemaID,[in] EnumDSSSourceManipulatorFlags iFlags,[in] EnumDSSSourceManipulatorFlags iFlags2,[in] EnumDSSInheritACL iACL,[in] EnumDSSConflictResolution iRuleGroupMembership,[in] EnumDSSConflictResolution iRuleSecurityRole,[in] EnumDSSConflictResolution iRuleConnectionMap,[in] EnumDSSConflictResolution iRuleUserPreferences,[in] EnumDSSConflictResolution iRuleSecurityFilter)
	Method to deal with the preamble of a delta file.
HRESULT	UpdateSchema ([in] EnumDSSSourceManipulationSchema iUpdateFlags)
	Method to deal with an instruction "update schema".

---

Member Function Documentation

HRESULT IDSSSourceManipulatorCallBack::DeleteObject (  [in] BSTR  iID, [in] EnumDSSObjectType  iType, [in] BSTR  iProjectID )

Method to deal with an extended object with instruction "delete". Parameters: iID  The ID of an object. iType  The type of an object. iProjectID  The project ID of an object. Returns: Usual COM result code.

HRESULT IDSSSourceManipulatorCallBack::LoadConflictRule (  [in] EnumDSSConflictDomain  iDomain, [in] VARIANT *  iSpecificDomain, [in] EnumDSSSourceFlags  iParts, [in] EnumDSSConflictResolution  iResolution )

Method to deal with a conflict rule. Parameters: iDomain  The domain of the conflict rule, e.g. DssConflictExplicitObject iSpecificDomain  The specific domain of the conflict rule, e.g., an object ID if iDomain is DssConflictExplicitObject. iParts  The parts where the conflict rule applies. iResolution  The resolution. Returns: Usual COM result code.

HRESULT IDSSSourceManipulatorCallBack::ManifestDependency (  [in] IDSSExtendedReference *  ipSourceReference, [in] IDSSExtendedReference *  ipDestinationReference, [in] IDSSExtendedData *  ipExtraData )

Report relevant dependencies between 2 objects in the dependents manifest. e.g., attributes to attribute forms dependencies, reports to attributes dependencies. When calling this method, the parent of the dependency should always be the most recently reported object. Parameters: ipSourceReference  A reference to the parent object in the dependents manifest ipDestinationReference  A reference to the child object in the dependents manifest ipExtraData  Extra data, e.g., the use name of a attribute form for a attribute. Returns: Usual COM result code.

HRESULT IDSSSourceManipulatorCallBack::ManifestObject (  [in] IDSSExtendedReference *  ipObjectReference, [in] IDSSExtendedData *  ipExtraData )

Report an object in the dependents manifest. Parameters: ipObjectReference  A reference to an object in the dependents manifest ipExtraData  Extra data, e.g., which report is the primary dataset of a RWD Returns: Usual COM result code.

HRESULT IDSSSourceManipulatorCallBack::MergeObject (  [in] IDSSExtendedObject *  ipExtended  )

Method to deal with a single extended object with instruction "merge". Parameters: ipExtended  An extended object. Returns: Usual COM result code.

HRESULT IDSSSourceManipulatorCallBack::MergeObjects (  [in] IDSSExtendedObjects *  ipExtended  )

Method to deal with a collection of extended objects with instruction "merge". Parameters: ipExtended  An collection of extended object. Returns: Usual COM result code.

HRESULT IDSSSourceManipulatorCallBack::ReportPreamble (  [in] Int32  iVersionNumber, [in] BSTR  iFileID, [in] BSTR  iMDVersion, [in] BSTR  iSchemaID, [in] EnumDSSSourceManipulatorFlags  iFlags, [in] EnumDSSSourceManipulatorFlags  iFlags2, [in] EnumDSSInheritACL  iACL, [in] EnumDSSConflictResolution  iRuleGroupMembership, [in] EnumDSSConflictResolution  iRuleSecurityRole, [in] EnumDSSConflictResolution  iRuleConnectionMap, [in] EnumDSSConflictResolution  iRuleUserPreferences, [in] EnumDSSConflictResolution  iRuleSecurityFilter )

Method to deal with the preamble of a delta file. Parameters: iVersionNumber  The version of product that generated the file iFileID  GUID that is unique to this file iMDVersion  MD version used to make file, e.g. “9.0.1” iSchemaID  GUID for project schema. GUID_NULL on config file iFlags  Manipulator level flags that are passed in file iFlags2  Extra manipulator level flags that are passed in file iACL  ACL inherit flags used by creating manipulator iRuleGroupMembership  Conflict rule for group membership iRuleSecurityRole  Conflict rule for security rules iRuleConnectionMap  Conflict rule for connection map iRuleUserPreferences  Conflict rule for all user preference links iRuleSecurityFilter  Conflict rule for security filter Returns: Usual COM result code.

HRESULT IDSSSourceManipulatorCallBack::UpdateSchema (  [in] EnumDSSSourceManipulationSchema  iUpdateFlags  )

Method to deal with an instruction "update schema". Parameters: iUpdateFlags  The updating schema flag. Returns: Usual COM result code.

---