WResourceShell Class Reference

#include <WResourceShell.h>

Inheritance diagram for WResourceShell:

Static Public Member Functions
static void	ReleaseResource (const SysHandle rsrcHandle)
static void	DetachResource (const SysHandle rsrcHandle)
static int32	GetSizeofResource (const SysHandle rsrcHandle)
static SysHandle	GetWinResource (LPTSTR rsrcType, LPTSTR id)
static SysHandle	GetWinResource (HMODULE hModule, LPTSTR rsrcType, LPTSTR id)
static SysHandle	GetResourceByID (RsrcType type, RsrcID id)
static SysHandle	GetResourceByIndex (RsrcType type, RsrcID index)
static int16	CountResources (RsrcType type)
Static Public Member Functions inherited from CResourceShell
static SysHandle	GetResource (const RsrcSpec &spec)
static int16	CountResourcesLI (const PMLocaleId &locale, RsrcType resType)
static int16	CountResourcesLI (const RsrcSpec &spec)
static SysHandle	GetResourceLI (const RsrcSpec &spec)
static void	EnumerateResourcesLI (const PMLocaleId &locale, const PluginID &pluginID, RsrcType resType, EnumResource func, void *enumData, bool16 resourceAlreadyOpened=kFalse)
static void	EnumerateResources (const PluginID &pluginID, RsrcType resType, EnumResource func, void *enumData)

Additional Inherited Members
Public Types inherited from CResourceShell
typedef bool16(*	EnumResource )(IPMStream *s, void *enumData)

Detailed Description

Windows implementation for some resource reading methods.

See Also

CResourceShell

Member Function Documentation

static int16 WResourceShell::CountResources ( RsrcType  type )

static

Get a count of resources of a certain type.

Parameters

type	which resource type

Returns

the count of resources of the desired type

static void WResourceShell::DetachResource ( const SysHandle  rsrcHandle )

inlinestatic

does nothing on windows. Provided so it's simpler to write cross platform code with #ifdefs

Parameters

rsrcHandle

ignored

SysHandle WResourceShell::GetResourceByID ( RsrcType  type, RsrcID  rsrcID  )

inlinestatic

Get a handle to a resource by ID.

Parameters

type	which resource type
id	which resource id

Returns

handle to the requested resource

See GetResourceByID()

static SysHandle WResourceShell::GetResourceByIndex ( RsrcType  type, RsrcID  index  )

static

Get a handle to a resource by index

Parameters

type	which resource type
index	which resource index

Returns

handle to the requested resource

static int32 WResourceShell::GetSizeofResource ( const SysHandle  rsrcHandle )

static

Get the size of a resource

Parameters

rsrcHandle

handle to the resource you want to know the size of.

Returns

size of the resource

static SysHandle WResourceShell::GetWinResource ( LPTSTR  rsrcType, LPTSTR  id  )

static

Windows only. Get a handle to a resource.

Parameters

rsrcType	which resource type as a string
id	which resource id, as a string

Returns

handle to the requested resource

static SysHandle WResourceShell::GetWinResource ( HMODULE  hModule, LPTSTR  rsrcType, LPTSTR  id  )

static

Windows only. Get a handle to a resource.

Parameters

hModule	- the module from which to load the resource from.
rsrcType	which resource type as a string
id	which resource id, as a string

Returns

handle to the requested resource

static void WResourceShell::ReleaseResource ( const SysHandle  rsrcHandle )

static

Releases resource handle. Usually called to free up memory after a call to GetResource.

Parameters

rsrcHandle

which handle to free