API Reference > OdEd Classes > OdEdUserIO Class > OdEdUserIO Methods > OdEdUserIO::getKeyword Method
OdEdUserIO::getKeyword Method
Collapse All
Syntax
C++
virtual int getKeyword(const OdString& prompt, const OdString& keywords, int defVal = -1, int options = OdEd::kInpDefault, OdEdIntegerTracker* pTracker = 0) = 0;
Parameters
Parameters 
Description 
const OdString& prompt 
[in] Prompt output before pausing for user input.  
const OdString& keywords 
[in] Keyword list.  
int defVal = -1 
[in] Returned if user input nothing. 
int options = OdEd::kInpDefault 
[in] Bitwise OR combination of OdEd::CommonInputOptions enum.  
Returns

Returns the index of the entered keyword in the keyword list, or -1 it's not there.

Description

Returns user input of a keyword. 

 

Remarks

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input. 

This function does not throw a KeywordException.

Group
Copyright © 2002–2020. Open Design Alliance. All rights reserved.
Send feedback about this topic