II3IDParameterDefinition::SetAsHiddenParameter Method

Synopsis

Implements functionality defined in I3IDToolReg.h's I3IDAddToolHiddenParameter method.

This method adds a run-time string parameter that is hidden from the user. The tool can use this as a way to "pass" itself extra information. Suppose, for example, that you want a single C function to support more than one external tool step at IP run-time. To do so, your C function must know the context in which it was used (i.e. which action the user wants to carry out).

This function can be used to achieve this capability. To do so, your DLL must register two different tools with Interaction Designer, but would specify the same C function in both cases.

Then for each of the registered tools, your DLL must add a hidden parameter that indicates which action the registered tool represents. At IP run-time, your C function will receive the value of that hidden parameter as a string input. Based on the value of that input, your function can perform the appropriate action.

IDL Function Prototype

 HRESULT SetAsHiddenParameter(

   [in] BSTR HiddenValue

);

C/C++ Syntax

HRESULT SetAsHiddenParameter(BSTR HiddenValue);

Parameters

HiddenValue

HiddenValue contains a string that is passed to the tool's runtime function.