CString CBCGPEdit::GetSearchPrompt ( ) const

inline

Returns a text string to be displayed in edit box in "search" mode.

Returns

A pointer to string if it was previously set by EnableSearchMode(); it's NULL if EnableSearchMode() has not been called.

Use this method to obtain a text string to be displayed in edit box in "search" mode.

In "search" mode the edit control displays a string defined by lpszPrompt (when no text is entered) and a "search" icon at the right side. When the user begins to type text, the prompt is cleared and a "clear" icon appears in place of the "search" icon. A click on the "clear" icon clears the entered text and brings back the "search" icon.

You can enable or disable "search" mode using EnableSearchMode() method.