Displays the specified prompt, local keywords, and default value for the Boolean in the command window and gets the user's input.
.NET Syntax
COM native C++ | |
---|
HRESULT PromptForBoolOrKeyword(
BSTR Prompt,
BSTR ErrorMsg,
VARIANT GlobalKeywordStrArray,
VARIANT LocalKeywordStrArray,
LONG PromptInit,
BSTR StringForTrue,
BSTR StringForFalse,
VARIANT_BOOL DefaultValue,
BSTR* Keyword,
VARIANT_BOOL* Value,
dsPromptResultType_e* Result
) |
C++ | |
---|
DSRESULT PromptForBoolOrKeyword(
const dsString& Prompt,
const dsString& ErrorMsg,
const dsStringArray& GlobalKeywordStrArray,
const dsStringArray& LocalKeywordStrArray,
long PromptInit,
const dsString& StringForTrue,
const dsString& StringForFalse,
bool DefaultValue,
dsString* Keyword,
bool* 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 to display in the command window, which are typically translated to the local language (see Remarks)
- PromptInit
- Prompt initialization as defined in dsPromptInit_e (see Remarks)
- StringForTrue
- Text that indicates to return true (see Remarks)
- StringForFalse
- Text that indicates to return false (see Remarks)
- DefaultValue
- Default Boolean value to display in the prompt in the command window (see Remarks)
- Keyword[out]
- Keyword input by the user
- Value[out]
- Boolean value input by the user
- Result[out] or Return Value
- Result as defined in dsPromptResultType_e
Remarks
See Also
Availability
DraftSight V1R4.0