Typing errors in documentation file

[tkondal]

Here's a typing error that I found in the documentation when looking at the doc for "ControlSendKeys":

"To send keyboard characters that are comprised of a regular keystroke in combination with a SHIFT, CTRL, or ALT, crete a compound "

"crete" should be "create".


Note: Maybe this thread should be used to post all documentation bugs so that they are consolidated.

[tkondal]

I also noted that the documenation for "ControlSendKeys" refers to the "SendKeys" method instead of "ControlSendKeys".

[admin]

Thank you for this info, we have corrected the documentation for the next release.

Jenö

[tkondal]

Here's another one in the ButtonCheck() and ButtonUncheck() docs:

If the button could be ckecked the return value is True, otherwise False.

and...

If the button could be unckecked the return value is True, otherwise False.

[admin]

Thank you for the info.
We have corrected the text for V1.1.0

Jenö

[tkondal]

Another one that caused me to spend a day on my script...

MouseClickElement():

"If the function succeeds, the return value is zero, otherwise the return value is an error code. "

In my case, when the function succeeds, it returns 1, and when it fails, it returns 0.

I have noted that there are many inconsistencies in the return codes for various functions. Just a suggestion for the next version, it would be easier for developers to compare the return code to a pre-defined constant.

Here's a Python code to show what I mean:

rc = Ranorex.MouseClickElement(eMyElement)
if (rc == Ranorex.RC_OK):
print "Success"
else:
print "Fail"

[admin]

Thank you for this important info, we checked the call chain of the mouse functions and found a bug. It can happen, that the functions MouseMoveToElement and MouseClickElement return a false value.

We corrected the bug for the next version V1.1.0.

[tkondal]

I noticed in the documentation for 1.1 that there is a "File List" item with "RanorexPython.cpp" in it; is this supposed to be there?

Also, the entry for "Menu Functions" has a ".n" appended to it.

[tkondal]

In the doc for Ranorex.TreeViewGetSelectedItem, it says:
The handle of the next item if successful,...

I'm guessing this should be :
The handle of the selected item if successful,...

[admin]

Thanks for this info...

[tkondal]

RanorexPython.ApplicationGetFirst

The documentation is misleading, the return type should be handle if successful, and 0 if not.

[admin]

Thank you for this info, we have corrected the documentation for the next release.

Please read also the post:

http://www.ranorex.com/forum/applicationgetnext-t147.html

Jenö
Ranorex Team