PromptForString Method (ICommandMessage)

PromptForString Method (ICommandMessage) | Send Feedback
See Also

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

IgnoreSpaces
  True to ignore spaces, false to not

Prompt
  Prompt message

DefaultString
  Default value

ResultString[out]

  User input value

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

# Syntax

Visual Basic |
--- | ---
    Function PromptForString( _
       ByVal IgnoreSpaces As System.Boolean, _
       ByVal Prompt As System.String, _
       ByVal DefaultString As System.String, _
       ByRef 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

# See Also

####

ICommandMessage Interface
ICommandMessage Members
ICommandMessage::PromptForStringOrKeyword Method ()

# Availability

DraftSight V1R1.4