This is new wiki software and old wiki content. It's a work in progress!
Here's the explanation.
Be gentle, report bugs, leave feedback on pages, or just edit them yourself! Thanks!

SDL Wiki

SDL_OpenURL

Open a URL/URI in the browser or other appropriate external application.

Syntax

int SDL_OpenURL(const char *url);

Function Parameters

url

A valid URL/URI to open. Use file:///full/path/to/file for local files, if supported.

Return Value

Returns 0 on success, or -1 on error; call SDL_GetError() for more information.

Remarks

Open a URL in a separate, system-provided application. How this works will vary wildly depending on the platform. This will likely launch what makes sense to handle a specific URL's protocol (a web browser for http://, etc), but it might also be able to launch file managers for directories and other things.

What happens when you open a URL varies wildly as well: your game window may lose focus (and may or may not lose focus if your game was fullscreen or grabbing input at the time). On mobile devices, your app will likely move to the background or your process might be paused. Any given platform may or may not handle a given URL.

If this is unimplemented (or simply unavailable) for a platform, this will fail with an error. A successful result does not mean the URL loaded, just that we launched _something_ to handle it (or at least believe we did).

All this to say: this function can be useful, but you should definitely test it on every platform you target.

Version

This function is available since SDL 2.0.14.


CategoryAPI, CategoryHeader


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.