OdEdUserIO::getString Method

Syntax

C++

virtual OdString getString(const OdString& prompt, int options = OdEd::kInpDefault, const OdString& defValue = OdString::kEmpty, const OdString& keywords = OdString::kEmpty, OdEdStringTracker* pTracker = 0) = 0;

Parameters	Description
const OdString& prompt	[in] Prompt output before pausing for user input.
int options = OdEd::kInpDefault	[in] combination of OdEd::CommonInputOptions and OdEd::GetStringOptions enum values.
const OdString& defValue = OdString::kEmpty	[in] Default value.
const OdString& keywords = OdString::kEmpty	[in] Keyword string.
OdEdStringTracker* pTracker = 0	[in] Pointer to an IO Tracker for this user input.

Returns user input of a string.

If prompt is empty, a default prompt is used.

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