PromptForFileNameOrKeyword Method (ICommandMessage) Send Feedback
See Also 
Result[out]
Result as defined in dsPromptResultType_e
Prompt[out]
Text for the prompt to display in the command window
ErrorMsg
Error message to display in the command window when the user's 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)
DefaultFileName
Default value for the path and file name to display in the command window (see Remarks)
Keyword[out]
Keyword input by the user
FileName[out]
Path and file name input by the user
Displays the specified prompt, local keywords, and default value for the file name in command window and gets the user's input.

Syntax

Visual Basic 
Function PromptForFileNameOrKeyword( _
   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 DefaultFileName As System.String, _
   ByRef Keyword As System.String, _
   ByRef FileName As System.String _
) As dsPromptResultType_e
C# 
dsPromptResultType_e PromptForFileNameOrKeyword( 
   System.string Prompt,
   System.string ErrorMsg,
   System.object GlobalKeywordStrArray,
   System.object LocalKeywordStrArray,
   System.int PromptInit,
   System.string DefaultFileName,
   out System.string Keyword,
   out System.string FileName
)
JavaScript 
PromptForFileNameOrKeyword( 
   Prompt : String,
   ErrorMsg : String,
   GlobalKeywordStrArray : Array,
   LocalKeywordStrArray : Array,
   PromptInit : Number,
   DefaultFileName : String
) : {
   Keyword : String,
   FileName : String,
   Result : String
}
COM native C++ 
HRESULT PromptForFileNameOrKeyword( 
   BSTR Prompt,
   BSTR ErrorMsg,
   VARIANT GlobalKeywordStrArray,
   VARIANT LocalKeywordStrArray,
   LONG PromptInit,
   BSTR DefaultFileName,
   BSTR* Keyword,
   BSTR* FileName,
   dsPromptResultType_e* Result
) 
C++ 
DSRESULT PromptForFileNameOrKeyword( 
   const dsString& Prompt,
   const dsString& ErrorMsg,
   const dsStringArray& GlobalKeywordStrArray,
   const dsStringArray& LocalKeywordStrArray,
   long PromptInit,
   const dsString& DefaultFileName,
   dsString* Keyword,
   dsString* FileName,
   dsPromptResultType_e* Result
) 

Parameters

Prompt[out]
Text for the prompt to display in the command window
ErrorMsg
Error message to display in the command window when the user's 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)
DefaultFileName
Default value for the path and file name to display in the command window (see Remarks)
Keyword[out]
Keyword input by the user
FileName[out]
Path and file name 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