Function PromptForMouseOrKeyword( _
   BSTR Prompt As System.String, _
   BSTR ErrorMsg As System.String, _
   VARIANT GlobalKeywordStrArray As System.Object, _
   VARIANT LocalKeywordStrArray As System.Object, _
   LONG PromptInit As System.Integer, _
   VARIANT_BOOL ShowRubberLine As System.Boolean, _
   IMathPoint* DefaultValue As MathPoint, _
   IMathPoint* BasePoint As MathPoint, _
   IMathPlane* Plane As MathPlane, _
   BSTR* Keyword As System.String, _
   IMathPoint** ResultPoint As MathPoint, _
   dsPromptKeyboardModificators_e* Modificators As dsPromptKeyboardModificators_e, _
   dsMouseEventType_e* MouseResult As dsMouseEventType_e _
) As dsPromptResultType_e

dsPromptResultType_e PromptForMouseOrKeyword( 
   System.string Prompt,
   System.string ErrorMsg,
   System.object GlobalKeywordStrArray,
   System.object LocalKeywordStrArray,
   System.int PromptInit,
   System.bool ShowRubberLine,
   MathPoint DefaultValue,
   MathPoint BasePoint,
   MathPlane Plane,
   out System.string Keyword,
   out MathPoint ResultPoint,
   out dsPromptKeyboardModificators_e Modificators,
   out dsMouseEventType_e MouseResult
)

PromptForMouseOrKeyword( 
   Prompt : System.String,
   ErrorMsg : System.String,
   GlobalKeywordStrArray : System.Object,
   LocalKeywordStrArray : System.Object,
   PromptInit : Number,
   ShowRubberLine : Boolean,
   DefaultValue : MathPoint,
   BasePoint : MathPoint,
   Plane : MathPlane,
   Keyword : System.String,
   ResultPoint : MathPoint,
) : {
   Modificators : String,
   MouseResult : String,
   Result : String
}

HRESULT PromptForMouseOrKeyword( 
   const dsString& Prompt,
,
   const dsString& ErrorMsg,
,
   VARIANT GlobalKeywordStrArray,
,
   VARIANT LocalKeywordStrArray,
,
   long PromptInit,
,
   bool ShowRubberLine,
,
   dsMathPoint* DefaultValue,
,
   dsMathPoint* BasePoint,
,
   dsMathPlane* Plane,
,
   dsString* Keyword,
,
   dsMathPoint** ResultPoint,
,
   dsPromptKeyboardModificators_e* Modificators,
   dsMouseEventType_e* MouseResult
   dsPromptResultType_e* Result
) 

DSRESULT PromptForMouseOrKeyword( 
   BSTR Prompt,
,
   BSTR ErrorMsg,
,
   VARIANT GlobalKeywordStrArray,
,
   VARIANT LocalKeywordStrArray,
,
   LONG PromptInit,
,
   VARIANT_BOOL ShowRubberLine,
,
   IMathPoint* DefaultValue,
,
   IMathPoint* BasePoint,
,
   IMathPlane* Plane,
,
   BSTR* Keyword,
,
   IMathPoint** ResultPoint,
,
   dsPromptKeyboardModificators_e* Modificators,
   dsMouseEventType_e* MouseResult
   dsPromptResultType_e* Result
) 

Parameters

Prompt

Text for the prompt to display in the command window

ErrorMsg

Error message to display in the command window if the user input is invalid

GlobalKeywordStrArray

Array of global keyword strings, which typically are language independent (see Remarks)

LocalKeywordStrArray

Array of local keyword strings, which are typically translated to the local language (see Remarks)

PromptInit

Prompt initialization as defined in dsPromptInit_e (see Remarks)

ShowRubberLine

True to display a rubber band that stretches from the origin, or from the BasePoint, to the location of the cursor; false to not display the rubber band (see Remarks)

DefaultValue

Default value for the mouse click point in the command window prompt (see Remarks)

BasePoint

Base point (see Remarks)

Plane

Projection plane

Keyword

User's keyword input

ResultPoint

User's click Point

Modificators

User's key click modifiers as defined in dsPromptKeyboardModificators_e

MouseResult

User's mouse click type as defined in dsMouseEventType_e

Parameters

Result[out] or Return Value

Result as defined in dsPromptResultType_e

ShowRubberLine must be set to true for the values specified for BasePoint to have an effect. The rubber band stretches from the BasePoint (or origin) to the location of the cursor in the drawing.

Keywords are context-sensitive options that are available in the Options toolbar when executing a command. Keywords in LocalKeywordStrArray are displayed in the prompt in the command window during user interaction. Keywords in GlobalKeywordStrArray are not displayed in the prompt in the command window. However, users can type global keywords in 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.