Hide Table of Contents
PromptForBool Method (ICommandMessage)
Result[out]
True if the prompt appears in the command window, false if not

Displays the specified prompt and default Boolean value in the command window and gets the Boolean input by the user.

.NET Syntax

Visual Basic (Declaration) 
Function PromptForBool( _
   BSTR Prompt As System.String, _
   BSTR StringForTrue As System.String, _
   BSTR StringForFalse As System.String, _
   VARIANT_BOOL DefaultValue As System.Boolean, _
   VARIANT_BOOL* Value As System.Boolean _
) As System.Boolean
C# 
System.bool PromptForBool( 
   System.string Prompt,
   System.string StringForTrue,
   System.string StringForFalse,
   System.bool DefaultValue,
   out System.bool Value
)
JavaScript 
PromptForBool( 
   Prompt : System.String,
   StringForTrue : System.String,
   StringForFalse : System.String,
   DefaultValue : Boolean,
) : {
   Value : Boolean,
   Result : Boolean
}
COM native C++ 
HRESULT PromptForBool( 
   const dsString& Prompt,
,
   const dsString& StringForTrue,
,
   const dsString& StringForFalse,
,
   bool DefaultValue,
,
   bool* Value
,
   VARIANT_BOOL* Result
)
C++ 
DSRESULT PromptForBool( 
   BSTR Prompt,
,
   BSTR StringForTrue,
,
   BSTR StringForFalse,
,
   VARIANT_BOOL DefaultValue,
,
   VARIANT_BOOL* Value
,
   bool* Result
)

Parameters

Prompt
Text of prompt
StringForTrue
Text that indicates to return true (see Remarks)
StringForFalse
Text that indicates to return false (see Remarks)
DefaultValue
Default value
Value[out]
Boolean value

Parameters

Result[out] or Return Value
True if the prompt appears in the command window, false if not

Remarks

StringForTrue and StringForFalse:

  • 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.
 

See Also

Availability

DraftSight V1R1.1


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:   PromptForBool 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) 2025 SP2

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.

0.20.46