SFBRscPool

Wrapper Class for the IRscPool interface.

#include <SFBRscPool.h.hpp>

class SFBRscPool : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBRscPool)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	O	O	O

Reference

BREW API IRscPool

Member

Public Functions
`Void`	Free( `VoidPtr` p ) De-associates a memory pointer with the lifetime of a SFBRscPool and frees it.
`SFCError`	HoldRsc( `SFBBaseSmpConstRef` resource ) Associates a generic SFBBase pointer with the lifetime of a SFBRscPool.
`VoidPtr`	Malloc( `UInt32` size ) Allocates memory and associates it with the lifetime of a SFBRscPool.
static `SFBRscPoolSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBRscPool instance.
static `SFBRscPoolSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBRscPool instance.
`UInt32`	ReleaseRsc( `SFBBaseSmpConstRef` resource ) De-associates a generic SFBBase instance with the lifetime of a SFBRscPool instance, release the SFBBase.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBRscPool::Free

De-associates a memory pointer with the lifetime of a SFBRscPool and frees it.

[ public ]
Void Free(
    VoidPtr p   // pointer to free 
);

Reference

BREW API IRSCPOOL_Free

SFBRscPool::HoldRsc

Associates a generic SFBBase pointer with the lifetime of a SFBRscPool.

[ public ]
SFCError HoldRsc(
    SFBBaseSmpConstRef resource   // thing to keep track of 
);

Reference

BREW API IRSCPOOL_HoldRsc

SFBRscPool::Malloc

Allocates memory and associates it with the lifetime of a SFBRscPool.

[ public ]
VoidPtr Malloc(
    UInt32 size   // number of bytes to allocate
);

Reference

BREW API IRSCPOOL_Malloc

SFBRscPool::NewInstance

Create a new SFBRscPool instance.

[ public, static ]
SFBRscPoolSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBRscPoolSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBRscPool::ReleaseRsc

De-associates a generic SFBBase instance with the lifetime of a SFBRscPool instance, release the SFBBase.

[ public ]
UInt32 ReleaseRsc(
    SFBBaseSmpConstRef resource   // thing to release 
);

Reference

BREW API IRSCPOOL_ReleaseRsc