SFBSuppsTrans

Wraper class for the ISuppsTrans interface.

#include <SFBSuppsTrans.h.hpp>

class SFBSuppsTrans : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBSuppsTrans)

Inheritance diagram

Version

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

Reference

BREW API ISuppsTrans

Member

Public Functions
`SFCError`	GetResult( `const AEETSuppsStatus**` result ) Get the result of processed transaction.
`AEETSuppsTransState`	GetState( `Void` ) Obtain the state of transaction.
`SFCError`	LoadMessage( `const EETSuppsMessage*` message , `UInt32` size ) Load the given message for the transaction.
`SFCError`	ParseString( `ACharConstPtr` string , `AEETSuppsMessage*` message , `UInt32Ptr` size ) A helper routine to verify the validity of a string request.
`SFCError`	ParseString( `SFXAnsiStringConstRef` string , `AEETSuppsMessage*` message , `UInt32Ptr` size ) A helper routine to verify the validity of a string request.
`Void`	Run( `SFXCallbackPtr` callback ) Run the transaction to process the loaded message.
`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.

SFBSuppsTrans::GetResult

Get the result of processed transaction.

[ public ]
SFCError GetResult(
    const AEETSuppsStatus** result   // the address of inner buffer will be returned
);

Return value

If succeeds: SFERR_NO_ERROR
result is null: SFERR_INVALID_PARAM
Transaction is on processing, no result: SFERR_INVALID_STATE

Reference

BREW API ISUPPSTRANS_GetResult

SFBSuppsTrans::GetState

Obtain the state of transaction.

[ public ]
AEETSuppsTransState GetState(Void);

Reference

BREW API ISUPPSTRANS_GetState

SFBSuppsTrans::LoadMessage

Load the given message for the transaction.

[ public ]
SFCError LoadMessage(
    const EETSuppsMessage* message   // message to send
    UInt32 size                      // size of message buffer
);

Return value

If succeeds: SFERR_NO_ERROR
message is null: SFERR_INVALID_PARAM
Application does not have sufficient privileges to load this message : EPRIVLEVEL

Reference

BREW API ISUPPSTRANS_LoadMessage

SFBSuppsTrans::ParseString

A helper routine to verify the validity of a string request.

[ public ]
SFCError ParseString(
    ACharConstPtr string        // null terminated string
    AEETSuppsMessage* message   // buffer to place the parsed message request
    UInt32Ptr size              // buffer size
);

[ public ]
SFCError ParseString(
    SFXAnsiStringConstRef string   // string
    AEETSuppsMessage* message      // buffer to place the parsed message request
    UInt32Ptr size                 // buffer size
);

Return value

If succeeds: SFERR_NO_ERROR
string is null: SFERR_INVALID_PARAM
buffer at message is insufficient : EPRIVLEVEL

Reference

BREW API ISUPPSTRANS_ParseString

SFBSuppsTrans::Run

Run the transaction to process the loaded message.

[ public ]
Void Run(
    SFXCallbackPtr callback   // callback to resume when transaction halts
);

Reference

BREW API ISUPPSTRANS_Run