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

Developer

API Reference

IRESFILE_GETSTRING()

Brew Release
Brew MP 1.0.2
See Also
IResFile IResFile_Get() ISHELL_LoadResString()
Description
This method is deprecated.
Retrieves a string resource with given id from IResFile. This function can also be used to request the size of a string resource in the resource file
If successful, the number of bytes copied with be stored in len.
Params
po
[]:
A pointer to an IResFile object.
resid
[]:
id of the string resource to be loaded
buf
[]:
pointer to a buffer where the resource data is to be loaded into
plen
[]:
Pointer to size of resource or input buffer

Interface
  • IRESFILE
Prototype
  •    int   IRESFILE_GetString(IResFile *po, uint32 resid, AECHAR *buf, uint32 *plen) {
    
Return
  • SUCCESS, if the resource was found EFAILED, if the resource could not be found or failed to load
Side Effect
  • None
Comments
If the pointer to the given buffer is set to -1 the size of the resource will be returned in the size field. This function is a macro for calling IResFile_Get() with RESTYPE_STRING.