Reference » Window classes » MWindow » digStringRef

Elgrint::MWindow::digStringRef() method

Declaration (see MWindow.h):

MString& digStringRef();

Description

Provides message-specific information for StringEntered.

Return type: MString&

Details

Returns the character (or characters) that triggered the current message.

If called not from OnStringEntered, the function generates a one-time warning 3001 and returns a dummy reference, the content of which is undefined (most likely empty, though).

The function returns a reference to a string, which can be modified by OnStringEntered handler and passed to the base class handler for more processing. See StringEntered for details and example. Of course, the result has to be modified by reference - copying it to a local variable and modifying that variable would have no effect.

Let us know

Please Contact us to report any errors on this page, or to suggest any improvements.

Miranor Home | About Miranor | About Elgrint | Create account | Login | Account settings | Contact Us | Privacy Policy | Site map

© Copyright 2014 by Miranor. All rights reserved. By using this site you agree to the Terms of Use.

Page last updated on August 10th, 2014.