IDSSPromptLocation Interface Reference

List of all members.

---

Detailed Description

We assume that the reader is familiar with the Usage of Prompts document.

That document defines all of the concepts used in this document.

The resolution object uses a collection of these interfaces to give context information about each prompt question in the resolution object. Each one of these interfaces describes a single prompt instance that is answered by the question. We describe a prompt instance by passing out the object that contains the instance, the instance's Index in the object and the instance itself.

The interface is read only. It does not make sense for a user to modify where a prompt question comes from. It is for information purposes only.

Public Member Functions
HRESULT	Container ([out, retval] IDSSObjectInfo ppContainer)
	The application object that contains this instance Container is a read-only DSS Object property.
HRESULT	Index ([out, retval] Int32 *pIndex)
	The instance's location in the Container's prompts Index is a read-only long property.
HRESULT	Prompt ([out, retval] IDSSPrompt ppPrompt)
	The specific prompt instance (default) This is the default method of this interface.

---

Member Function Documentation

HRESULT IDSSPromptLocation::Container (  [out, retval] IDSSObjectInfo   ppContainer  )

The application object that contains this instance Container is a read-only DSS Object property. It returns the application object that contains the prompt instance that is mapped to this question. Suppose that Location is an IDSSPromptLocation interface. Then the expression Location.Container.Prompts ( Location.Index ) returns the same prompt instance as Location.Prompt. Parameters: ppContainer  The application object that contains this prompt instance Will never be NULL Returns: Usual COM result code: S_OK

HRESULT IDSSPromptLocation::Index (  [out, retval] Int32 *  pIndex  )

The instance's location in the Container's prompts Index is a read-only long property. It is the index number of the prompt instance returned by the Prompt property in its container. This property is a shortcut to Prompt.Index. The number in the Index property has nothing to do with the position of this prompt location object in the collection of prompt location objects that contains it. Parameters: pIndex  The index number of Prompt in Container Is always greater than or equal to 1 Returns: Usual COM result code: S_OK

HRESULT IDSSPromptLocation::Prompt (  [out, retval] IDSSPrompt   ppPrompt  )

The specific prompt instance (default) This is the default method of this interface. This is a read-only prompt property. It returns the prompt instance that underlies the question. Usually this is a prompt instance based on the same prompt object as the prompt question whose prompt location collection exposed this prompt location. However the prompt instance could be based on a different prompt object, if the ImportAs or ExportAs properties were used to import a property based on a different prompt object. Both prompts always have the same prompt type. If a user is using an out of date resolution object, it is possible that the instance it refers to no longer exists. If this happens we return an error. The COM API detects this if either there is no instance of the stored instance number, or if the instance it finds is the wrong type of prompt. This error does not occur during report execution, since we use the binding table to insulate us from object changes during report execution. Returns: Usual COM result code: S_OK DSSCOM_E_OBJECT_CHANGED The prompt instance referred to in the resolution object does not seem to exist any more.

---