Hide Table of Contents
PromptForBoolOrKeyword Method (ICommandMessage)
Result[out]
Result as defined in dsPromptResultType_e

Displays the specified prompt, local keywords, and default value for the Boolean in the command window and gets the user's input.

.NET Syntax

Visual Basic (Declaration) 
Function PromptForBoolOrKeyword( _
   const dsString& Prompt As System.String, _
   const dsString& ErrorMsg As System.String, _
   const dsStringArray& GlobalKeywordStrArray As System.Object, _
   const dsStringArray& LocalKeywordStrArray As System.Object, _
   long PromptInit As System.Integer, _
   const dsString& StringForTrue As System.String, _
   const dsString& StringForFalse As System.String, _
   bool DefaultValue As System.Boolean, _
   dsString* Keyword As System.String, _
   bool* Value As System.Boolean _
) As dsPromptResultType_e
C# 
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
)
JavaScript 
PromptForBoolOrKeyword( 
   Prompt : String,
   ErrorMsg : String,
   GlobalKeywordStrArray : Array,
   LocalKeywordStrArray : Array,
   PromptInit : Number,
   StringForTrue : String,
   StringForFalse : String,
   DefaultValue : Boolean
) : {
   Keyword : String,
   Value : Boolean,
   Result : String
}
COM native C++ 
HRESULT 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
) 
C++ 
DSRESULT PromptForBoolOrKeyword( 
   const dsString& Prompt,
   const dsString& ErrorMsg,
   const dsStringArray& GlobalKeywordStrArray,
   const dsStringArray& LocalKeywordStrArray,
   long PromptInit,
   const dsString& StringForTrue,
   const dsString& StringForFalse,
   bool DefaultValue,
   dsString* Keyword,
   bool* Value,
   dsPromptResultType_e* Result
) 

Parameters

Prompt[out]
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
Result[out] or Return Value
Result as defined in dsPromptResultType_e

Remarks

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.
 

See Also

Availability

DraftSight V1R4.0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   PromptForBoolOrKeyword Method (ICommandMessage)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:



x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2019 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.