PromptForStringOrKeyword Method (ICommandMessage)

PromptForStringOrKeyword Method (ICommandMessage) | Send Feedback
See Also

Result[out]
  Result as defined in dsPromptResultType_e

IgnoreSpaces
  True to ignore spaces, false to not

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, which are typically translated to the local language (see Remarks)

PromptInit
  Prompt initialization as defined in dsPromptInit_e (see Remarks)

DefaultString
  Default string to show at the prompt in the command window (see Remarks)

Keyword[out]
  Keyword input by user

ResultString[out]
  String input by user

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

# Syntax

Visual Basic |
--- | ---
    Function PromptForStringOrKeyword( _
       ByVal IgnoreSpaces As System.Boolean, _
       ByVal Prompt As System.String, _
       ByVal ErrorMsg As System.String, _
       ByVal GlobalKeywordStrArray As System.Object, _
       ByVal LocalKeywordStrArray As System.Object, _
       ByVal PromptInit As System.Integer, _
       ByVal DefaultString As System.String, _
       ByRef Keyword As System.String, _
       ByRef ResultString As System.String _
    ) As dsPromptResultType_e

C# |
--- | ---
    dsPromptResultType_e PromptForStringOrKeyword(
       System.bool IgnoreSpaces,
       System.string Prompt,
       System.string ErrorMsg,
       System.object GlobalKeywordStrArray,
       System.object LocalKeywordStrArray,
       System.int PromptInit,
       System.string DefaultString,
       out System.string Keyword,
       out System.string ResultString
    )

JavaScript |
--- | ---
    PromptForStringOrKeyword(
       IgnoreSpaces : Boolean,
       Prompt : String,
       ErrorMsg : String,
       GlobalKeywordStrArray : Array,
       LocalKeywordStrArray : Array,
       PromptInit : Number,
       DefaultString : String
    ) : {
       Keyword : String,
       ResultString : String,
       Result : String
    }

COM native C++ |
--- | ---
    HRESULT PromptForStringOrKeyword(
       VARIANT_BOOL IgnoreSpaces,
       BSTR Prompt,
       BSTR ErrorMsg,
       VARIANT GlobalKeywordStrArray,
       VARIANT LocalKeywordStrArray,
       LONG PromptInit,
       BSTR DefaultString,
       BSTR* Keyword,
       BSTR* ResultString,
       dsPromptResultType_e* Result
    )

C++ |
--- | ---
    DSRESULT PromptForStringOrKeyword(
       bool IgnoreSpaces,
       const dsString& Prompt,
       const dsString& ErrorMsg,
       const dsStringArray& GlobalKeywordStrArray,
       const dsStringArray& LocalKeywordStrArray,
       long PromptInit,
       const dsString& DefaultString,
       dsString* Keyword,
       dsString* ResultString,
       dsPromptResultType_e* Result
    )

#### Parameters

IgnoreSpaces
  True to ignore spaces, false to not
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, which are typically translated to the local language (see Remarks)
PromptInit
  Prompt initialization as defined in dsPromptInit_e (see Remarks)
DefaultString
  Default string to show at the prompt in the command window (see Remarks)
Keyword[out]
  Keyword input by user
ResultString[out]
  String input by 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.

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

####

ICommandMessage Interface
ICommandMessage Members
ICommandMessage::PromptForString Method ()

# Availability

DraftSight V1R4.0