hgeResourceManager::GetEffect

Returns handle to a named sound effect.

HEFFECT GetEffect(
  const char *name,
  int resgroup = 0
);

Parameters

name

Sound effect name.

resgroup

Resource group identificator.

Return value

If successful, returns handle to the sound effect. Otherwise returns 0.

Remarks

You could use the name defined in the resource script or just a plain file name, either absolute or relative to the application folder or resource package root.

If the sound effect hasn't been loaded yet, it will be loaded. Otherwise handle to the existing effect will be returned.

The resgroup parameter is only used if you specify plain file name. When loading resources defined in resource script, resgroup is taken from the script. Use the value passed here with Purge to free the resource. If =0 or omitted - no specific group will be assigned to the recource.

Requirements

Header: hgeresource.h
Import library: hgehelp.lib