IDSSPlaceholder Interface Reference

List of all members.

---

Detailed Description

Object that records information about an object that can be used in reconciliation.

Our intention is that this interface can be used in two contexts. First it can be used as the main interface for a DSS Place Holder object. Second it can be used for transient placeholders created during a reconciliation operation by a source mapipulator. At the time of writing only the transient usage is implemented.

A place holder object records information about an object that is pertinent to a reconciliation operation. This information comes in two kinds.

First some information is information about an object that might be replaced which could guide the end user. For example we give the name and full path of each object. This information is collected for two reasons. First it makes it easier for higher level code that doesn't need to collect the informaiton. Second it is possible reconciliation can be performed in an environment where we don't have access to the original objects, causing the place holder information to be the only source of information. Placeholders transmitted in this manner with a delta file are refers to as a manifest.

Second a place holder records information that should be maintained during reconciliation. For example we record important dependencies. It should be noted that we do not record ALL dependencies, only those that matter.

Public Member Functions
HRESULT	Count ([out, retval] Int32 *opCount)
	Get the number of constaints recorded for this object.
HRESULT	Info ([out, retval] IDSSObjectInfo oppInfo)
	Obtain an object info interface for this object.
HRESULT	Item ([in] Int32 iIndex,[out, retval] IDSSReconciliationConstraint oppConstraint)
	Get a particular constaint from the collection.
HRESULT	MainReference ([out, retval] IDSSExtendedReference oppReference)
	The main object whose place this object represents.
HRESULT	Meaning ([in] BSTR iMeaning)
	A long string used to define the meaning of a placeholder.
HRESULT	Meaning ([out, retval] BSTR *opMeaning)
	A long string used to define the meaning of a placeholder.
HRESULT	ReconcileRoles ([out, retval] EnumDSSReconcileRoles *opType)
	This read-only property indicates the role of the placeholder in a reconciliation.
HRESULT	ReconcileType ([out, retval] EnumDSSReconcileType *opType)
	This read-only property indicates the type of the placeholder.
HRESULT	Title ([in] BSTR iTitle)
	A short string used, in context, to title the prompt.
HRESULT	Title ([out, retval] BSTR *opTitle)
	A short string used, in context, to title a placeholder.

---

Member Function Documentation

HRESULT IDSSPlaceholder::Count (  [out, retval] Int32 *  opCount  )

Get the number of constaints recorded for this object. Parameters: opCount  Return the count, never null on success. Returns: Usual COM result code.

HRESULT IDSSPlaceholder::Info (  [out, retval] IDSSObjectInfo   oppInfo  )

Obtain an object info interface for this object. If this placeholder object really is a DSS Object, then it will be the placeholder's standard object info. If this object is not a DSS Object, then we will attempt to obtain an object info interface for its main object. It is possible that no such object will be findable, in which case this method will return an error.

HRESULT IDSSPlaceholder::Item (  [in] Int32  iIndex, [out, retval] IDSSReconciliationConstraint   oppConstraint )

Get a particular constaint from the collection. Parameters: iIndex  Index number of desired constaint oppConstraint  Return one of the constaints.

HRESULT IDSSPlaceholder::MainReference (  [out, retval] IDSSExtendedReference   oppReference  )

The main object whose place this object represents. We return the object as an extended reference. This provides the usual ID information. It also gives the name (and all its translations), subtype and full path.

HRESULT IDSSPlaceholder::Meaning (  [in] BSTR  iMeaning  )

A long string used to define the meaning of a placeholder. Not implemented on a temporary placeholder.

HRESULT IDSSPlaceholder::Meaning (  [out, retval] BSTR *  opMeaning  )

A long string used to define the meaning of a placeholder. Not implemented on a temporary placeholder.

HRESULT IDSSPlaceholder::ReconcileRoles (  [out, retval] EnumDSSReconcileRoles *  opType  )

This read-only property indicates the role of the placeholder in a reconciliation. This property would not be used for a DSS Place Holder object. It is needed when we are exposing placeholders from a source manipulator to describe information about a hypothetical reconciliation. The role of a placeholder depends on how we expect to use the object. Since a placeholder might have multiple roles, we use a bit vector

HRESULT IDSSPlaceholder::ReconcileType (  [out, retval] EnumDSSReconcileType *  opType  )

This read-only property indicates the type of the placeholder. The value is drawn from the same enumeration of a reconciliation key. The purpose here is to provide an easy way to distinguish between a place holder object, or a temporary object exposing information for a particular reconciliation.

HRESULT IDSSPlaceholder::Title (  [in] BSTR  iTitle  )

A short string used, in context, to title the prompt. Not implemented on a temporary placeholder.

HRESULT IDSSPlaceholder::Title (  [out, retval] BSTR *  opTitle  )

A short string used, in context, to title a placeholder. Not implemented on a temporary placeholder.

---