VCGetPrompt
VCSetPrompt


Version:

1.2

Description:

Specifies the prompt for a User Tool.

Declaration:

 

C/C++

extern "C" short WINAPI VCGetPrompt(short iPromptIndex, char* szPrompt);
extern "C" vbool WINAPI VCSetPrompt(short iPromptIndex, char* szPrompt);

Delphi

function VCGetPrompt(iPromptIndex: Smallint; szPrompt: PAnsiChar):Smallint; stdcall;
function VCSetPrompt(iPromptIndex: Smallint; szPrompt: PAnsiChar); Smallint; stdcall;

ActiveX/COM

Function GetPrompt(ByVal iPromptIndex As Integer) As String
Function SetPrompt(ByVal iPromptIndex As Integer, ByVal szPrompt As String) As Integer

Parameters:

iPromptIndex - the step number to which the prompt is assigned.
szPrompt
- a string representing the prompt to be displayed.

Notes:

When custom tools are created, prompts should always be displayed to the user in order to explain what steps or input is required at each step. The first prompt is set with VCSetUserTool and all subsequent prompts should be set with VCSetPrompt. VCGetPrompt will conversely return any of the existing prompts.

See Also:

VCSetAlertApp, VCGetUserToolLBDown