NumOfPrompts Function

Retrieves the number of prompts currently being used in the report that is being processed.

Syntax

NumOfPrompts(
    IPROMPTSET_HANDLE i_hIPromptSet, 
    int* o_iIndex) 

    Parameters

i_hIPromptSet [In]

The handle to the IPromptSet interface. See hIPromptSet Variable.

o_iIndex [Out]

The size of the prompt set array.

Returns

Each function returns a RET_VALUE that is an error code of type Long. The return value is greater than zero if the call was successful, and zero or less if not. Use RET_OK(x) and RET_ERROR(x) to check for failure.

Remarks

This function retrieves the number of prompts that are shared between the main report and its subreports. Unlike other interfaces, the IPromptSet interface does not distinguish between reports and subreports; thus, when calling prompt-related functions, the o_isSubReport parameter from the GetReportTitle Function is always False.