PromptForDistanceOrKeyword Method (ICommandMessage) Send Feedback
See Also 
Result[out]
Result as defined in dsPromptResultType_e
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)
DefaultValue
Default double value to display in the prompt in the command window (see Remarks)
Keyword[out]
Keyword input by the user
Value[out]
Linear distance input by the user
Obsolete. Superseded by ICommandMessage::PromptForDistanceOrKeyword2.

Syntax

Visual Basic 
Function PromptForDistanceOrKeyword( _
   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 DefaultValue As System.Double, _
   ByRef Keyword As System.String, _
   ByRef Value As System.Double _
) As dsPromptResultType_e
C# 
dsPromptResultType_e PromptForDistanceOrKeyword( 
   System.string Prompt,
   System.string ErrorMsg,
   System.object GlobalKeywordStrArray,
   System.object LocalKeywordStrArray,
   System.int PromptInit,
   System.double DefaultValue,
   out System.string Keyword,
   out System.double Value
)
JavaScript 
PromptForDistanceOrKeyword( 
   Prompt : String,
   ErrorMsg : String,
   GlobalKeywordStrArray : Array,
   LocalKeywordStrArray : Array,
   PromptInit : Number,
   DefaultValue : Number
) : {
   Keyword : String,
   Value : Number,
   Result : String
}
COM native C++ 
HRESULT PromptForDistanceOrKeyword( 
   BSTR Prompt,
   BSTR ErrorMsg,
   VARIANT GlobalKeywordStrArray,
   VARIANT LocalKeywordStrArray,
   LONG PromptInit,
   DOUBLE DefaultValue,
   BSTR* Keyword,
   DOUBLE* Value,
   dsPromptResultType_e* Result
) 
C++ 
DSRESULT PromptForDistanceOrKeyword( 
   const dsString& Prompt,
   const dsString& ErrorMsg,
   const dsStringArray& GlobalKeywordStrArray,
   const dsStringArray& LocalKeywordStrArray,
   long PromptInit,
   double DefaultValue,
   dsString* Keyword,
   double* 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, which are typically translated to the local language (see Remarks)
PromptInit
Prompt initialization as defined in dsPromptInit_e (see Remarks)
DefaultValue
Default double value to display in the prompt in the command window (see Remarks)
Keyword[out]
Keyword input by the user
Value[out]
Linear distance 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.

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