Developer

API Reference

IResFile

Brew Release
Brew MP 1.0.2
Description

IResFile is an interface that can be used to retrieve resources from BREW resource files. The interface is intended to be used instead of the ISHELL_LoadRes equivalents, but uses the same constants as the ISHELL equivalents.
In addition, IResFile has APIs to help form and widget based applications apply theme information, used with named entries in resource files which can be created using the theme compiler.
For more information about themes, and a list of default names used with common forms, please see IROOTFORM_ApplyWProps() and IFORM_SetThemeBaseName().
The following APIs are provided to support an object reference counting mechanism for objects to manage their own memory instances.
   IResFile_AddRef()
   IResFile_Release()

The following APIs are provided to support the ability to query other interfaces from an object.
   IResFile_QueryInterface()

The following APIs are provided to open and close resource files.
   IResFile_Open()
   IResFile_Close() 

The following APIs are provided to get resources from an open resource file
   IResFile_Get()
   IResFile_GetObject()

The following APIs are provided to get named resources from an open resource file
   IResFile_GetNamed()
   IResFile_GetNamedObject()

The following APIs are provided to get the id for a named resources from an open resource file
   IResFile_GetNamedId()

IResFile supports standard resource file types listed in AEEShell.h (ResType enum). In addition, IResFile supports the following:
   
   RESTYPE_WPROPS: A collection of properties (ID / value pairs), 8 bytes each (4 bytes ID, 4 bytes value)

IResFile_GetNamed() can be used to retrieve objects of type RESTYPE_WPROPS
Usage

After having created an instance of this class, open one or more resource files using IResFile_Open. Retireve any needed information from the resource file(s) using the IResFile_Get* functions. When you have finished loading neccessary information from these resource files and don't think you will need them in the future, close the files using IResFile_Close and release your reference to the IResFile.
  • Follow