DragonFly On-Line Manual Pages

al_cstr(3)                                                          al_cstr(3)

NAME
       al_cstr - Allegro 5 API

SYNOPSIS

              #include <allegro5/allegro.h>

              const char *al_cstr(const ALLEGRO_USTR *us)

DESCRIPTION
       Get a char * pointer to the data in a string.  This pointer will only
       be valid while the underlying string is not modified and not destroyed.
       The pointer may be passed to functions expecting C-style strings, with
       the following caveats:

       o ALLEGRO_USTRs are allowed to contain embedded NUL ('') bytes.  That
         means al_ustr_size(u) and strlen(al_cstr(u)) may not agree.

       o An ALLEGRO_USTR may be created in such a way that it is not NUL
         terminated.  A string which is dynamically allocated will always be
         NUL terminated, but a string which references the middle of another
         string or region of memory will not be NUL terminated.

       o If the ALLEGRO_USTR references another string, the returned C string
         will point into the referenced string.  Again, no NUL terminator will
         be added to the referenced string.

SEE ALSO
       al_ustr_to_buffer(3), al_cstr_dup(3)

Allegro reference manual                                            al_cstr(3)