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

Developer

API Reference

IRESFILE_GETNAMED()

Brew Release
Brew MP 1.0.2
See Also
IResFile Interface IResFile_GetObject() ISHELL_LoadResObject()
Description

Gets a named resource 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 named string, for example, could look like:
      IResFile_GetNamed(piResFile, RESTYPE_STRING, pbuf, &size, "Main", "Menu", "Open", 0)

or could look like:
      IResFile_GetNamed(piResFile, RESTYPE_STRING, pbuf, &size, "Main.Menu.Open", 0)

or a mix of the above:
      IResFile_GetNamed(piResFile, RESTYPE_STRING, pbuf, &size, "Main.Menu", "Open", 0)
Params
pif
[]:
[in] A pointer to an IResFile object.
restype
[]:
[in] Type of the resource to be loaded
pbuf
[]:
[out] Pointer to a buffer where the resource data is to be loaded into
plen
[]:
[out] Pointer to where the size of the loaded resource can be stored ...: [in] Null-terminated string list of names (see above)

Interface
Prototype
  •    int IResFile_GetNamed(IResFile *pif, uint16 restype, void *pbuf, uint32 *plen, ...)
    
Return
  •    AEE_SUCCESS:       Named resource was found and loaded
       AEE_EBADSTATE:     Resource file is not open 
       AEE_EUNSUPPORTED:  Resource file does not support named resources
       AEE_EUNABLETOLOAD: Named resource could not be resolved or loaded
    
Side Effect
  • None
Comments
This function is a shortcut function for the actual interface function IResFile_GetNamedV() which takes an actual vararg parameter.