API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IRESFILE_GETNAMEDIMAGE()

Brew Release
Brew MP 1.0.2
See Also
IResFile IResFile_GetNamedObject() IResFile_GetNamed()
Description
This method is deprecated.
Gets a named image from a resource file. Names for a resource can be given as a variable set of, null terminated, string arguments. Each string specifies one or more levels in the naming tree. A simple string without '.' characters specifies a single level in the naming tree where as a dot separated set of names in a string specify a series of names in the naming tree.
Loading a image, for example, could look like:
      IResFile_GetNamedImage(piResFile, (void**)&piImage, "Main", "Background", "Image", 0))

or could look like:
      IResFile_GetNamedImage(piResFile, (void**)&piImage, "Main.Background.Image", 0))

or a mix of the above:
      IResFile_GetNamedImage(piResFile, (void**)&piImage, "Main", "Background.Image", 0))
Params
po
[]:
A pointer to an IResFile object.
ppo
[]:
Pointer to an IImage pointer ...: null terminated string arguments (see above)

Interface
  • IRESFILE
Prototype
  •    int IRESFILE_GetNamedImage(IResFile *po, void **ppo, ...)
    
Return
  • SUCCESS, if the named resource was found and loaded EBADSTATE, if this resource file is not open EUNSUPPORTED, if this resource file does not support named resources EUNABLETOLOAD, if the named resource could not be resolved or loaded
Side Effect
  • None
Comments
This function is a shortcut function for the interface function IResFile_GetNamedImageV which takes an actual vararg parameter. IRESFILE_GetNamedImageV is actually a shortcut for the IResFile_GetNamedObject function with HTYPE_VIEWER.