Added a warning comment to SDL_putenv().
authorRyan C. Gordon <icculus@icculus.org>
Tue, 15 Dec 2009 18:00:16 +0000
changeset 3567fb9ea4b549c3
parent 3566 07c8339c95c6
child 3568 8c72321542f6
Added a warning comment to SDL_putenv().

"Fixes" Bugzilla #779.
include/SDL_stdinc.h
     1.1 --- a/include/SDL_stdinc.h	Tue Dec 15 09:20:10 2009 +0000
     1.2 +++ b/include/SDL_stdinc.h	Tue Dec 15 18:00:16 2009 +0000
     1.3 @@ -267,6 +267,16 @@
     1.4  extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
     1.5  #endif
     1.6  
     1.7 +/**
     1.8 + * \warning On some platforms, the string you pass to SDL_putenv() becomes
     1.9 + *          part of the environment table directly...it will use this specific
    1.10 + *          buffer, and not a copy of it! This means you can't free it, and
    1.11 + *          other pieces of code may try to write to it. In practice, this
    1.12 + *          isn't a big deal, but be aware of the possibility.
    1.13 + *          However, due to this issue, you should be prepared to
    1.14 + *          pass a (char*), or be willing to cast away the constness of your
    1.15 + *          string for this call.
    1.16 + */
    1.17  #ifdef HAVE_PUTENV
    1.18  #define SDL_putenv	putenv
    1.19  #else