Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
get_config_text(3)		Allegro	manual		    get_config_text(3)

NAME
       get_config_text	- Returns a string translated to the current language.
       Allegro game programming	library.

SYNOPSIS
       #include	<allegro.h>

       const char *get_config_text(const char *msg);

DESCRIPTION
       This function is	primarily intended for use by internal	library	 code,
       but  it	may  perhaps be	helpful	to application programmers as well. It
       uses the	`language.dat' or `XXtext.cfg' files (where XX is  a  language
       code) to	look up	a translated version of	the parameter in the currently
       selected	language.

       This  is	 basically  the	same thing as calling get_config_string() with
       `[language]' as the section, `msg' as the variable name,	and  `msg'  as
       the  default value, but it contains some	special	code to	handle Unicode
       format conversions. The `msg' parameter is always given in  ASCII  for-
       mat,  but  the  returned	string will be converted into the current text
       encoding, with memory being allocated as	required, so  you  can	assume
       that  this  pointer  will  persist  without having to manually allocate
       storage space for each string.

       Note that if you	are planning on	distributing your  game	 on  the  Unix
       platform	 there	is  a  special	issue  with how	to deal	with the `lan-
       guage.dat' file.	Read section "Files shared by Allegro" of the  chapter
       "Unix specifics"	to learn more about this.

RETURN VALUE
       Returns a suitable translation if one can be found or a copy of the pa-
       rameter if nothing else is available.

SEE ALSO
       get_config_string(3), reload_config_texts(3)

Allegro				 version 4.4.3		    get_config_text(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=get_config_text&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help