API Reference > Classes > PRC Protocol Extensions Classes > ExPrcCommandContext Class > ExPrcCommandContext Methods > ExPrcCommandContext::getKeyword Method
ExPrcCommandContext::getKeyword Method
Syntax
C++
virtual int getKeyword(const OdString& prompt, const OdString& keywords, int defRes = -1, int options = OdEd::kInpDefault, OdEdIntegerTracker* pTracker = 0);
Parameters 
Description 
const OdString& prompt 
[in] A prompt string with text printed before waiting for user input.  
const OdString& keywords 
[in] A keyword list.  
int defRes = -1 
[in] A default value returned if user inputs a keyword that does not in the keywords list.  
int options = OdEd::kInpDefault 
[in] A set of input options (bitwise or combination of the OdEd::CommonInputOptions enum).  
OdEdIntegerTracker* pTracker = 0 
[in] A pointer to a notification interface for tracking changes in the command context object.  

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

Gets user input of a keyword value from the command's input.

Copyright (c) 2002-2020. Open Design Alliance. All rights reserved.