SFBEnv

Wrapper Class for the IEnv interface.

#include <SFBEnv.h.hpp>

class SFBEnv : public SFBRealloc;

SFMTYPEDEFWRAPPER(SFBEnv)

Inheritance diagram

Version

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

Reference

BREW API IAddrInfo

Member

Public Functions
`SFCError`	AtExit( `PFNNOTIFY` notify , `VoidPtr` context ) Allows caller to register (or deregister) a function to be called during Env cleanup.
`SFCError`	CreateInstance( `AEECLSID` id , `SFBBaseSmpPtr` result ) Instantiates the specified class, if possible.
static `SFBEnvSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBEnv instance.
static `SFBEnvSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBEnv instance.
`Void`	ERRMALLOCREC( `VoidPtrPtr` block ) (inherits from SFBRealloc) Allocate a typed block of memory
`Void`	ERRMALLOCRECEX( `UInt32` u , `VoidPtrPtr` block ) (inherits from SFBRealloc) Allocate a typed block of memory plus some extra space.
`SFCError`	ErrMalloc( `SInt32` size , `VoidPtrPtr` block ) (inherits from SFBRealloc) Allocates a block of memory. The memory is zero-initialized.
`SFCError`	ErrMallocName( `SInt32` size , `VoidPtrPtr` block , `ACharConstPtr` name ) (inherits from SFBRealloc) Allocates a block of memory, and tags it with a name.
`SFCError`	ErrMallocName( `SInt32` size , `VoidPtrPtr` block , `SFXAnsiStringConstRef` name ) (inherits from SFBRealloc) Allocates a block of memory, and tags it with a name.
`SFCError`	ErrMallocNameNoZI( `SInt32` size , `VoidPtrPtr` block , `ACharConstPtr` name ) (inherits from SFBRealloc) This function is the same as SFBRealloc::ErrMallocName(), except that the new memory is not zero-initializated.
`SFCError`	ErrMallocNameNoZI( `SInt32` size , `VoidPtrPtr` block , `SFXAnsiStringConstRef` name ) (inherits from SFBRealloc) This function is the same as SFBRealloc::ErrMallocName(), except that the new memory is not zero-initializated.
`SFCError`	ErrMallocNoZI( `SInt32` size , `VoidPtrPtr` block ) (inherits from SFBRealloc) This function is exactly the same as SFBRealloc::ErrMalloc(), except that the new memory is not zero-initializated.
`SFCError`	ErrRealloc( `SInt32` size , `VoidPtrPtr` block ) (inherits from SFBRealloc) Reallocs a block of memory. Any newly allocated memory is zero-initialized.
`SFCError`	ErrReallocName( `SInt32` size , `VoidPtrPtr` block , `ACharConstPtr` name ) (inherits from SFBRealloc) Reallocates a block of memory to a new size, assigning it a name. Any newly allocated memory is zero-initialized.
`SFCError`	ErrReallocName( `SInt32` size , `VoidPtrPtr` block , `SFXAnsiStringConstRef` name ) (inherits from SFBRealloc) Reallocates a block of memory to a new size, assigning it a name. Any newly allocated memory is zero-initialized.
`SFCError`	ErrReallocNameNoZI( `SInt32` size , `VoidPtrPtr` block , `ACharConstPtr` name ) (inherits from SFBRealloc) This function is the same as SFBRealloc::ErrReallocName(), except that the new memory is not zero-initializated.
`SFCError`	ErrReallocNameNoZI( `SInt32` size , `VoidPtrPtr` block , `SFXAnsiStringConstRef` name ) (inherits from SFBRealloc) This function is the same as SFBRealloc::ErrReallocName(), except that the new memory is not zero-initializated.
`SFCError`	ErrReallocNoZI( `SInt32` size , `VoidPtrPtr` block ) (inherits from SFBRealloc) This function is the same as SFBRealloc::ErrRealloc(), except that the new memory is not zero-initializated.
`Void`	FREE_IF( `VoidPtr` block ) (inherits from SFBRealloc) Free a pointer and set to NULL
`SFCError`	Free( `VoidPtr` block ) (inherits from SFBRealloc) Frees a block of memory, given its pointer. If passed NULL, it does nothing.
`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.

SFBEnv::AtExit

Allows caller to register (or deregister) a function to be called during Env cleanup.

[ public ]
SFCError AtExit(
    PFNNOTIFY notify   // Function to call on system exit. A value of NULL cancels all function previously registered with the same pCtx value. 
    VoidPtr context    // Function context to be passed to pfnAtExit. 
);

Return value

AEE_SUCCESS if all goes well, otherwise a failure-specific error value

Description

The AtExit callbacks are called in reverse order of subscription.

Reference

BREW API IEnv_AtExit

SFBEnv::CreateInstance

Instantiates the specified class, if possible.

[ public ]
SFCError CreateInstance(
    AEECLSID id            // The AEECLSID of the class to instantiate 
    SFBBaseSmpPtr result   // pointer to be filled with new instance of the class requested 
);

Return value

AEE_SUCCESS if instance of class created, otherwise a failure-specific error value from AEEError.h

Reference

BREW API IEnv_CreateInstance

SFBEnv::NewInstance

Create a new SFBEnv instance.

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

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