Function PromptForDistanceOrKeyword( _
   const dsString& Prompt As System.String, _
   const dsString& ErrorMsg As System.String, _
   const dsStringArray& GlobalKeywordStrArray As System.Object, _
   const dsStringArray& LocalKeywordStrArray As System.Object, _
   long PromptInit As System.Integer, _
   double DefaultValue As System.Double, _
   dsString* Keyword As System.String, _
   double* Value As System.Double _
) As dsPromptResultType_e

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
)

PromptForDistanceOrKeyword( 
   Prompt : String,
   ErrorMsg : String,
   GlobalKeywordStrArray : Array,
   LocalKeywordStrArray : Array,
   PromptInit : Number,
   DefaultValue : Number
) : {
   Keyword : String,
   Value : Number,
   Result : String
}

HRESULT PromptForDistanceOrKeyword( 
   BSTR Prompt,
   BSTR ErrorMsg,
   VARIANT GlobalKeywordStrArray,
   VARIANT LocalKeywordStrArray,
   LONG PromptInit,
   DOUBLE DefaultValue,
   BSTR* Keyword,
   DOUBLE* Value,
   dsPromptResultType_e* Result
) 

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

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.