Developer

API Reference

IResFile_GetNamedObject()

Brew Release
Brew MP 1.0.2
See Also
IResFile Interface IResFile_GetNamed()
Description

Gets a named object 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_GetNamedObject(piResFile, HTYPE_VIEWER, &piImage, "Main", "Background", "Image", 0)

or could look like:
      IResFile_GetNamedObject(piResFile, HTYPE_VIEWER, &piImage, "Main.Background.Image", 0)

or a mix of the above:
      IResFile_GetNamedObject(piResFile, HTYPE_VIEWER, &piImage, "Main", "Background.Image", 0)
Parameters
  • pif
    []:
    [in] A pointer to an IResFile object.
  • clsid
    []:
    [in] Class ID of the handler (see ISHELL_LoadResObject(), AEEHandlerType)
  • ppif
    []:
    [out] Pointer to the object pointer where object will be loaded ...: [in] Null-terminated string list of names (see above)

Interface
Prototype
   int IResFile_GetNamedObject(IResFile *pif, AEECLSID clsid, void **ppif, ...)
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
Comment
This function is a shortcut function for the actual interface function IResFile_GetNamedObjectV() which takes an actual vararg parameter.
  • Follow