Function PromptForKeyword2( _
   BSTR Prompt As System.String, _
   BSTR ErrorMsg As System.String, _
   VARIANT GlobalKeywordStrArray As System.Object, _
   VARIANT LocalKeywordStrArray As System.Object, _
   LONG PromptInit As System.Integer, _
   BSTR DefaultValue As System.String, _
   BSTR* Value As System.String _
) As dsPromptResultType_e

dsPromptResultType_e PromptForKeyword2( 
   System.string Prompt,
   System.string ErrorMsg,
   System.object GlobalKeywordStrArray,
   System.object LocalKeywordStrArray,
   System.int PromptInit,
   System.string DefaultValue,
   out System.string Value
)

PromptForKeyword2( 
   Prompt : System.String,
   ErrorMsg : System.String,
   GlobalKeywordStrArray : System.Object,
   LocalKeywordStrArray : System.Object,
   PromptInit : Number,
   DefaultValue : System.String,
   Value : System.String\n) : String

HRESULT PromptForKeyword2( 
   const dsString& Prompt,
,
   const dsString& ErrorMsg,
,
   VARIANT GlobalKeywordStrArray,
,
   VARIANT LocalKeywordStrArray,
,
   long PromptInit,
,
   const dsString& DefaultValue,
,
   dsString* Value
,
   dsPromptResultType_e* Result
) 

DSRESULT PromptForKeyword2( 
   BSTR Prompt,
,
   BSTR ErrorMsg,
,
   VARIANT GlobalKeywordStrArray,
,
   VARIANT LocalKeywordStrArray,
,
   LONG PromptInit,
,
   BSTR DefaultValue,
,
   BSTR* Value
,
   dsPromptResultType_e* Result
) 

Parameters

Prompt

Text to display as the prompt in the command window

ErrorMsg

Error message to display in the command window when the user input is invalid

GlobalKeywordStrArray

Array of global keywords, which are typically language independent

LocalKeywordStrArray

Array of local keywords, which are typically translated to the local language

PromptInit

Prompt initialization as defined in dsPromptInit_e (see Remarks)

DefaultValue

Default value for the keyword to display in the prompt in the command window (see Remarks)

Value[out]

Keyword input by the user

Parameters

Result[out] or Return Value

Result as defined in dsPromptResultType_e

Local keywords can be seen in the prompt in the command window during user interaction. Global keywords cannot be seen in the prompt in the command window. However, users can type global keywords at the prompt in the command window if they know them.

If the PromptInit parameter is set to:

• dsPromptInit_e.dsPromptInit_NoDefault and a value is specified for DefaultValue, then the value is not used or displayed in the prompt in the command window.
• dsPromptInit_e.UsePromptExplanation, then call ICommandMessage::PromptExplanation to specify the text for PromptInit.