Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDL_GetWMInfo return code documented wrong in header #552

Closed
SDLBugzilla opened this issue Feb 10, 2021 · 0 comments
Closed

SDL_GetWMInfo return code documented wrong in header #552

SDLBugzilla opened this issue Feb 10, 2021 · 0 comments

Comments

@SDLBugzilla
Copy link
Collaborator

This bug report was migrated from our old Bugzilla tracker.

Reported in version: 1.2.14
Reported for operating system, platform: All, All

Comments on the original bug report:

On 2010-02-20 18:37:22 +0000, Maarten ter Huurne wrote:

In SDL_syswm.h, the documentation for SDL_GetWMInfo() states "If it's not implemented, or the version member of the 'info' structure is invalid, it returns 0."

The doc wiki states "1 if the function is implemented and no error occured, 0 if function is unimplemented, -1 if implemented but a failure occurred."

In SDL_x11wm.c, the implementation of X11_GetWMInfo() returns -1 if the 'info' structure contains a version number larger than the version of the SDL library being called.

Since the doc wiki and the implementation agree, I am assuming the header file gets it wrong. If that is indeed the case, please fix the documentation in the header file. In the mean time, I'm going to assume that any return value greater than 0 means success.

On 2010-07-18 10:41:41 +0000, Sam Lantinga wrote:

This is fixed in revision 3f2d351d8274. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant