OUI_LanguageImage_Default()
See also: OpenLanguages API
Return to Introduction  Previous page  Next page

This function is used to return an image based on the current Language (or a default). It uses the format:

<MvFUNCTION NAME = "OUI_LanguageImage_Default" PARAMETERS = "group, id, height VAR, width VAR, default, defh, defw"  STANDARDOUTPUTLEVEL = "">  

This function is called with the parameters:

·l.group      set to the group "code" (see OUI_LangGroup_Create())  
·l.id      set to a ID number unique for each image within the specified group  
·l.height      used to return the value of the image height  
·l.width      used to return the value of the image width  
·l.default   set to the default path to return if the image is not found  
·l.defh      set to the default height to return if the image is not found  
·l.defw      set to the default width to return if the image is not found  

The return value is either the contents of l.default (if not found or an error occurred) or the actual image path, after processing it for OpenTokens. (To get the image fields before processing, such as for displaying in your module's admin screens, use OUI_LanguageImage_Raw()). The l.height and l.width values are assigned the contents of l.defh and l.defw (if not found or an error occurred) or the actual image height and width values.

 

Send feedback on this documentation.
© 2004 - 2000 Darren Ehlers & OpenUI Developer Consortium