SFBSMSMsg

Wrapper class for the ISMSMsg interface.

#include <SFBSMSMsg.h.hpp>

class SFBSMSMsg : public SFBWebOpts;

SFMTYPEDEFWRAPPER(SFBSMSMsg)

Inheritance diagram

Version

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

Reference

BREW API ISMSMsg

Member

Public Functions
`SFCError`	GetOpt( `SInt32` id , `SMSMsgOpt*` opt ) Find most recently added SMSMsgOpt, in the list of SMSMsgOpts.
`SFCError`	GetOptWithIndex( `SInt32` id , `SInt32` index , `SMSMsgOpt*` opt ) Find SMSMsgOpt, in the list of SMSMsgOpts.
static `SFBSMSMsgSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBSMSMsg instance.
static `SFBSMSMsgSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBSMSMsg instance.
`SFCError`	RemoveOpt( `SInt32` id ) Removes the most recently added SMSMsgOpt matching id.
`SFCError`	AddOpt( `WebOptPtr` opts ) (inherits from SFBWebOpts) Add the list of WebOpts to the current web option set.
`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.

SFBSMSMsg::GetOpt

Find most recently added SMSMsgOpt, in the list of SMSMsgOpts.

[ public ]
SFCError GetOpt(
    SInt32 id        // id of the option to find in the options list
    SMSMsgOpt* opt   // where to stick the found SMSMsgOpt
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API ISMSMSG_GetOpt

SFBSMSMsg::GetOptWithIndex

Find SMSMsgOpt, in the list of SMSMsgOpts.

[ public ]
SFCError GetOptWithIndex(
    SInt32 id        // id of the option to find in the options list
    SInt32 index     // option index
    SMSMsgOpt* opt   // where to stick the found SMSMsgOpt
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API ISMSMSG_GetOptWithIndex

SFBSMSMsg::NewInstance

Create a new SFBSMSMsg instance.

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

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

SFBSMSMsg::RemoveOpt

Removes the most recently added SMSMsgOpt matching id.

[ public ]
SFCError RemoveOpt(
    SInt32 id   // id of the option to remove from the options list
);

Return value

If succeeds: SFERR_NO_ERROR
If failed: SFERR_FAILED

Reference

BREW API ISMSMSG_RemoveOpt