SFBForceFeed

Wrapper Class for the IForceFeed interface.

#include <SFBForceFeed.h.hpp>

class SFBForceFeed : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBForceFeed)

Inheritance diagram

Version

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

Reference

BREW API IForceFeed

Member

Public Functions
static `SFBForceFeedSmp`	NewInstance( `SFBImageDecoderSmpConstRef` decoder , `SFCErrorPtr` exception = null ) Create a new SFBForceFeed instance.
static `SFBForceFeedSmp`	NewInstance( `SFBImageDecoderSmpConstRef` decoder , `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBForceFeed instance.
`Void`	Reset( `Void` ) Prepare the object to accept a new stream of data.
`SFCError`	Write( `VoidPtr` buf , `SInt32` bufSize ) This function is used to write data to the object.
`SFCError`	Write( `SFXBufferPtr` buf ) This function is used to write data to the object.
`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.

SFBForceFeed::NewInstance

Create a new SFBForceFeed instance.

[ public, static ]
SFBForceFeedSmp NewInstance(
    SFBImageDecoderSmpConstRef decoder   // SFBImageDecoder instance
    SFCErrorPtr exception = null         // Error
);

[ public, static ]
SFBForceFeedSmp NewInstance(
    SFBImageDecoderSmpConstRef decoder   // SFBImageDecoder instance
    AEECLSID id                          // Class ID
    SFCErrorPtr exception = null         // Error
);

SFBForceFeed::Reset

Prepare the object to accept a new stream of data.

[ public ]
Void Reset(Void);

Reference

BREW API IFORCEFEED_Reset | SFBForceFeed::Write

SFBForceFeed::Write

This function is used to write data to the object.

[ public ]
SFCError Write(
    VoidPtr buf      // pointer to buffer containing data to write
    SInt32 bufSize   // number of bytes of data to write
);

[ public ]
SFCError Write(
    SFXBufferPtr buf   // pointer to buffer containing data to write
);

Return value

If succeeds: SFERR_NO_ERROR
buf is null: SFERR_INVALID_PARAM
If failed: Error code defined in AEEError.h

Reference

BREW API IFORCEFEED_Write | SFBForceFeed::Reset