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

Displays the specified prompt and default value in the command window and gets the user's input.

.NET Syntax

Visual Basic (Declaration) 
Function PromptForString( _
   bool IgnoreSpaces As System.Boolean, _
   const dsString& Prompt As System.String, _
   const dsString& DefaultString As System.String, _
   dsString* ResultString As System.String _
) As System.Boolean
C# 
System.bool PromptForString( 
   System.bool IgnoreSpaces,
   System.string Prompt,
   System.string DefaultString,
   out System.string ResultString
)
JavaScript 
PromptForString( 
   IgnoreSpaces : Boolean,
   Prompt : String,
   DefaultString : String
) : {
   ResultString : String,
   Result : Boolean
}
COM native C++ 
HRESULT PromptForString( 
   VARIANT_BOOL IgnoreSpaces,
   BSTR Prompt,
   BSTR DefaultString,
   BSTR* ResultString,
   VARIANT_BOOL* Result
)
C++ 
DSRESULT PromptForString( 
   bool IgnoreSpaces,
   const dsString& Prompt,
   const dsString& DefaultString,
   dsString* ResultString,
   bool* Result
)

Parameters

IgnoreSpaces
True to ignore spaces, false to not
Prompt
Prompt message
DefaultString
Default value
ResultString[out]

User input value

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

Example

 

See Also

Availability

DraftSight V1R1.4


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:   PromptForString 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) 2023 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.

0.20.21