Function PromptForBoolOrKeyword( _
   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 StringForTrue As System.String, _
   BSTR StringForFalse As System.String, _
   VARIANT_BOOL DefaultValue As System.Boolean, _
   BSTR* Keyword As System.String, _
   VARIANT_BOOL* Value As System.Boolean _
) As dsPromptResultType_e

dsPromptResultType_e PromptForBoolOrKeyword( 
   System.string Prompt,
   System.string ErrorMsg,
   System.object GlobalKeywordStrArray,
   System.object LocalKeywordStrArray,
   System.int PromptInit,
   System.string StringForTrue,
   System.string StringForFalse,
   System.bool DefaultValue,
   out System.string Keyword,
   out System.bool Value
)

PromptForBoolOrKeyword( 
   Prompt : System.String,
   ErrorMsg : System.String,
   GlobalKeywordStrArray : System.Object,
   LocalKeywordStrArray : System.Object,
   PromptInit : Number,
   StringForTrue : System.String,
   StringForFalse : System.String,
   DefaultValue : Boolean,
   Keyword : System.String,
) : {
   Value : Boolean,
   Result : String
}

HRESULT PromptForBoolOrKeyword( 
   const dsString& Prompt,
,
   const dsString& ErrorMsg,
,
   VARIANT GlobalKeywordStrArray,
,
   VARIANT LocalKeywordStrArray,
,
   long PromptInit,
,
   const dsString& StringForTrue,
,
   const dsString& StringForFalse,
,
   bool DefaultValue,
,
   dsString* Keyword,
,
   bool* Value
,
   dsPromptResultType_e* Result
) 

DSRESULT PromptForBoolOrKeyword( 
   BSTR Prompt,
,
   BSTR ErrorMsg,
,
   VARIANT GlobalKeywordStrArray,
,
   VARIANT LocalKeywordStrArray,
,
   LONG PromptInit,
,
   BSTR StringForTrue,
,
   BSTR StringForFalse,
,
   VARIANT_BOOL DefaultValue,
,
   BSTR* Keyword,
,
   VARIANT_BOOL* 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 (see Remarks)

LocalKeywordStrArray

Array of local keywords to display in the command window, which are typically translated to the local language (see Remarks)

PromptInit

Prompt initialization as defined in dsPromptInit_e (see Remarks)

StringForTrue

Text that indicates to return true (see Remarks)

StringForFalse

Text that indicates to return false (see Remarks)

DefaultValue

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

Keyword[out]

Keyword input by the user

Value[out]

Boolean value input by the user

Parameters

Result[out] or Return Value

Result as defined in dsPromptResultType_e

Keywords are context-sensitive options that are available in the Options toolbar when executing a command. 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.

The StringForTrue and StringForFalse parameters:

• can contain any combination of numbers, letters, and hyphens or only numbers, only letters, or only hyphens.
• cannot contain spaces or any other special characters or symbols.

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.