IPromptSet Interface

This interface allows you to change prompt information that has been previously set in the main report and its subreports. Information about each prompt—for example, the prompt name and set of values—is stored in an array on the server; this array is considered to be the prompt set. The prompt set that is retrieved is a union of all report contexts; that is, it contains the prompts from the main report and each subreport.

You can visualize a prompt set in the following way:

A report may have a number of prompts. Each prompt may have one or more prompt values, and each of these prompt values may be discrete or ranged. A discrete value is a single value, and is represented by PromptValue1; a ranged value has two values (an upper bound and a lower bound), which are represented by PromptValue 1 and PromptValue 2 respectively.

Typically, you will want to find the total number of prompts, retrieve the information for each, and then change their values. To retrieve this interface, use the GetInterface Function or the GET_PROMPTSET_INTERFACE Macro.

Note:    

• The functions in this interface will ignore prompts whose values are not needed.
• You can only change existing prompt values. A value cannot be changed to NULL, nor can NULL be changed to a value.

Variables and Functions

Variables and Functions	Description
hIPromptSet Variable	A handle to the IPromptSet interface. You need to pass this handle to each function in the interface that you use. Read-Only.
NumOfPrompts Function	Retrieves the number of prompts currently being used in the report that is being processed.
GetName Function	Retrieves the name of a prompt currently being used in the report being processed.
GetSubReportName Function	Retrieves the name of the subreport in which a particular prompt is being used.
GetType Function	Retrieves the type of a particular prompt.
NumOfPromptValues Function	Retrieves the number of available values for a particular prompt.
GetPromptValue Function	Retrieves the value of a particular prompt.
SetPromptValue Function	Overwrites one of the values for a particular prompt.